AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

SpringBoot原理分析 | 开源框架：Swagger集成

2023-12-18 75
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： SpringBoot原理分析 | 开源框架：Swagger集成

Swagger

Swagger 是一个用于构建、文档化和测试 RESTful API 的开源框架。它可以通过自动生成 API 文档和客户端 SDK，从而简化了 API 的开发和维护工作。Swagger 支持多种编程语言和平台，包括 Java、Python、Node.js 等；Swagger 是一个非常实用的 API 开发和文档化工具，可以大大提高 API 的开发效率和质量

  • API 文档自动生成：通过注解和配置文件，Swagger 可以自动生成 API 的文档，包括接口的请求和响应参数、请求方式、返回结果等
  • API 测试工具：Swagger 提供了一个基于 Web 的 API 测试工具，可以方便地测试 API 的各种请求和响应结果
  • 客户端 SDK 生成：Swagger 可以根据 API 文档自动生成各种客户端 SDK，包括 Java、Python、Node.js 等
  • API 视图展示：Swagger 可以将 API 文档以清晰的视图展示出来，方便用户查看和理解 API 的使用方式

Springboot集成Swagger

  • 依赖导入
<!--springfox-boot-starter-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!--springfox-swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!--springfox-swagger-ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>
  • controller/SwaggerController.java
package com.wei.config;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
//开启Swagger2
@EnableSwagger2
public class SwaggerConfig {
}
  • SpringbootSwaggerApplication.java
package com.wei;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.oas.annotations.EnableOpenApi;
@SpringBootApplication
@EnableWebMvc
@EnableOpenApi
public class SpringbootSwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootSwaggerApplication.class, args);
    }
}
  • controller/HelloController.java
package com.wei.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello(){
        return "Hello,Swagger!";
    }
}
  • 浏览器访问：http://localhost:8080/swagger-ui/index.html

配置Swagger信息

  • confing/SwaggerConfig.java
package com.wei.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
@Configuration
//开启Swagger2
@EnableSwagger2
public class SwaggerConfig {
    //配置Swagger的Bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }
    //配置Swagger信息apiInfo
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("wei_shuo", "#", "1096075493@qq.com");
        return new ApiInfo(
                "wei_shuo API文档",
                "开源……",
                "1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}
  • 浏览器运行

配置扫描接口

  • confing/SwaggerConfig.java
package com.wei.config;
import com.wei.controller.HelloController;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
@Configuration
//开启Swagger2
@EnableSwagger2
public class SwaggerConfig {
    //配置Swagger的Bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //RequestHandlerSelectors 配置要扫描接口的方式
                //basePackage("com.wei.controller") 指定扫描包
                //.apis(RequestHandlerSelectors.basePackage("com.wei.controller"))
                //any() 扫描全部
                //.apis(RequestHandlerSelectors.any())
                //none() 不扫描
                //.apis(RequestHandlerSelectors.none())
                //withClassAnnotation() 扫描类注解
                //.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                //withMethodAnnotation(GetMapping.class) 扫描方法注解
                //.apis(RequestHandlerSelectors.withMethodAnnotation(GetMapping.class))
                .apis(RequestHandlerSelectors.basePackage("com.wei.controller"))
                //过滤路径
                .paths(PathSelectors.ant("/hello/**"))
                .build();
    }
    //配置Swagger信息apiInfo
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("wei_shuo", "#", "1096075493@qq.com");
        return new ApiInfo(
                "wei_shuo API文档",
                "开源……",
                "1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}
  • 配置是否启用swagger
//配置Swagger的Bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否启用swagger默认true
                .enable(false)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wei.controller"))
                .build();
    }

案例：根据项目环境，配置swagger

  • 分别创建properties的开发，测试，发布

  • application.properties
spring.profiles.active=dev
#spring.profiles.active=test
#spring.profiles.active=prod
  • application-dev.properties
server.port=8081
  • application-test.properties
server.port=8082
  • application-prod.properties
server.port=8083
  • confing/SwaggerConfig.java
package com.wei.config;
import com.wei.controller.HelloController;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
@Configuration
//开启Swagger2
@EnableSwagger2
public class SwaggerConfig {
    //配置Swagger的Bean实例
    @Bean
    public Docket docket(Environment environment){
        //设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev","test","prod");
        //通过environment.acceptsProfiles()判断项目环境
        boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否启用swagger默认true
                .enable(flag)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wei.controller"))
                .build();
    }

配置API分组

  • API文档分组
//API文档分组
.groupName("wei")
package com.wei.config;
import com.wei.controller.HelloController;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
@Configuration
//开启Swagger2
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docker1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A");
    }
    @Bean
    public Docket docker2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B");
    }
    @Bean
    public Docket docker3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C");
    }
    //配置Swagger的Bean实例
    @Bean
    public Docket docket(Environment environment){
        //设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev","test","prod");
        //通过environment.acceptsProfiles()判断项目环境
        boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //API文档分组
                .groupName("wei")
                //是否启用swagger默认true
                .enable(flag)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wei.controller"))
                .build();
    }
    //配置Swagger信息apiInfo
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("wei_shuo", "#", "1096075493@qq.com");
        return new ApiInfo(
                "wei_shuo API文档",
                "开源……",
                "1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}

实体类扫描

  • controller/HelloController.java
package com.wei.controller;
import com.wei.pojo.User;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(){
        return "Hello,Swagger!";
    }
    //接口中，返回值存在实体类，就会被扫描到Swagger
    @PostMapping("/user")
    public User user(){
        return new User();
    }
}
  • pojo/User.java

@Api：描述该类的属性和方法

@ApiModel：描述该类的属性和方法

@ApiModelProperty：描述该属性或方法的作用、类型、格式、是否必需等信息

package com.wei.pojo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
/**
 * @ClassName User
 * @Description TODO
 * @Author wei_shuo
 * @Date 2023/5/7 10:55
 * @Version 1.0
 */
@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}
  • controller/HelloController.java
package com.wei.controller;
import com.wei.pojo.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
@Api(tags = "Hello控制类")
@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello,Swagger!";
    }
    //接口中，返回值存在实体类，就会被扫描到Swagger
    @PostMapping("/user")
    public User user() {
        return new User();
    }
    @ApiOperation("Test控制类")
    @GetMapping("/test")
    public String test(@ApiParam("用户名") String username) {
        return "Hello" + username;
    }
}

🌼 结语：创作不易，如果觉得博主的文章赏心悦目，还请——点赞👍收藏⭐️评论📝

文章标签：
API
Java
开发工具
JavaScript
测试技术
关键词：
Spring Boot原理
Spring Boot分析
集成swagger
Spring Boot swagger
集成springboot
wei_shuo
目录
相关文章
喜欢猪猪
|
6天前
|
XML Java 开发者
Spring Boot开箱即用可插拔实现过程演练与原理剖析
【11月更文挑战第20天】Spring Boot是一个基于Spring框架的项目，其设计目的是简化Spring应用的初始搭建以及开发过程。Spring Boot通过提供约定优于配置的理念，减少了大量的XML配置和手动设置，使得开发者能够更专注于业务逻辑的实现。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理，并通过Java代码手写模拟Spring Boot的启动过程，为开发者提供一个全面的理解。
喜欢猪猪
16 0
游客zi3qmblbcdexu
|
1月前
|
Java Maven Docker
gitlab-ci 集成 k3s 部署spring boot 应用
gitlab-ci 集成 k3s 部署spring boot 应用
游客zi3qmblbcdexu
55 1
WangBai
|
10天前
|
Java Spring
SpringBoot自动装配的原理
在Spring Boot项目中，启动引导类通常使用`@SpringBootApplication`注解。该注解集成了`@SpringBootConfiguration`、`@ComponentScan`和`@EnableAutoConfiguration`三个注解，分别用于标记配置类、开启组件扫描和启用自动配置。
WangBai
47 17
潇洒洒
|
12天前
|
XML Java 数据库连接
SpringBoot集成Flowable：打造强大的工作流管理系统
在企业级应用开发中，工作流管理是一个核心组件，它能够帮助我们定义、执行和管理业务流程。Flowable是一个开源的工作流和业务流程管理（BPM）平台，它提供了强大的工作流引擎和建模工具。结合SpringBoot，我们可以快速构建一个高效、灵活的工作流管理系统。本文将探讨如何将Flowable集成到SpringBoot应用中，并展示其强大的功能。
潇洒洒
47 1
java冯坚持
|
1月前
|
SQL JSON Java
mybatis使用三：springboot整合mybatis，使用PageHelper 进行分页操作，并整合swagger2。使用正规的开发模式：定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作，并且集成Swagger2来生成API文档，同时定义了统一的数据返回格式和请求模块。
java冯坚持
54 1
mybatis使用三：springboot整合mybatis，使用PageHelper 进行分页操作，并整合swagger2。使用正规的开发模式：定义统一的数据返回格式和请求模块
刘大猫.
|
22天前
|
JSON Java API
springboot集成ElasticSearch使用completion实现补全功能
springboot集成ElasticSearch使用completion实现补全功能
刘大猫.
24 1
东方睿赢
|
30天前
|
Java Spring 容器
springboot @RequiredArgsConstructor @Lazy解决循环依赖的原理
【10月更文挑战第15天】在Spring Boot应用中，循环依赖是一个常见问题，当两个或多个Bean相互依赖时，会导致Spring容器陷入死循环。本文通过比较@RequiredArgsConstructor和@Lazy注解，探讨它们解决循环依赖的原理和优缺点。@RequiredArgsConstructor通过构造函数注入依赖，使代码更简洁；@Lazy则通过延迟Bean的初始化，打破创建顺序依赖。两者各有优势，需根据具体场景选择合适的方法。
东方睿赢
53 4
最好zzz
|
12天前
|
XML 存储 Java
SpringBoot集成Flowable：构建强大的工作流引擎
在企业级应用开发中，工作流管理是核心功能之一。Flowable是一个开源的工作流引擎，它提供了BPMN 2.0规范的实现，并且与SpringBoot框架完美集成。本文将探讨如何使用SpringBoot和Flowable构建一个强大的工作流引擎，并分享一些实践技巧。
最好zzz
34 0
java冯坚持
|
1月前
|
前端开发 Java 程序员
springboot 学习十五：Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
java冯坚持
92 1
java冯坚持
|
1月前
|
Java BI API
spring boot 整合 itextpdf 导出 PDF，写入大文本，写入HTML代码，分析当下导出PDF的几个工具
这篇文章介绍了如何在Spring Boot项目中整合iTextPDF库来导出PDF文件，包括写入大文本和HTML代码，并分析了几种常用的Java PDF导出工具。
java冯坚持
418 0
spring boot 整合 itextpdf 导出 PDF，写入大文本，写入HTML代码，分析当下导出PDF的几个工具

热门文章

最新文章

  • 1
    Spring Cloud Gateway 聚合swagger文档
  • 2
    Swagger Editor与Swagger-UI神器使用
  • 3
    颜值爆表！推荐两款JSON可视化工具，配合Swagger使用真香
  • 4
    Spring Boot 集成Swagger
  • 5
    提升API文档品质：Swagger annotations （注解）使用教程
  • 6
    NestJS 7.x 折腾记: (4) Swagger接入及相关用法
  • 7
    接口文档生成神器-Swagger3
  • 8
    Springboot集成Swagger2
  • 9
    SpringBoot 整合 Swagger 2
  • 10
    三：.net core（.NET 6）给swagger添加文档注释详细步骤
  • 1
    Springboot 使用自定义注解结合AOP方式校验接口参数
    79
  • 2
    企业级智能制造MES系统源码，技术架构：springboot + vue-element-plus-admin
    182
  • 3
    SpringBoot项目的用maven插件打包报Test错误
    121
  • 4
    SpringBoot使用@Scheduled定时任务录入将要过期任务数据
    133
  • 5
    springboot配合Freemark模板生成word,前台vue接收并下载【步骤详解并奉上源码】
    216
  • 6
    springboot @RequiredArgsConstructor @Lazy解决循环依赖的原理
    830
  • 7
    基于springboot+vue+Mysql的交流互动系统
    61
  • 8
    SpringBoot-----从前端更新数据到MySql数据库
    55
  • 9
    springboot DDD的概念以及实战
    536
  • 10
    Spring Boot项目打war包（idea:多种方式）
    195

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移
  • 事件总线EventBridge生态集成课程

    • 相关电子书

    更多
  • 阿里邮箱—安全高效集成
  • 集成智能接入网关APP：优化企业级移动办公网络
  • 云效助力企业集成安全到DevOps中

    • 相关实验场景

    更多
  • 从零搭建Spring Boot的Hello World
  • 搭建Java Web开发环境
  • 基于 IntelliJ IDEA 插件部署微服务应用
  • Rocketmq-spring入门与实践
  • Spring-cloud-stream-binder-rocketmq入门与实践
    • 下一篇
    阿里云OSS设置跨域访问