Spring Boot 整合 Swagger

矫情吗；* 2024-03-30 09:22 15阅读 0赞

**目录**

1. Swagger

1、引入依赖

2、创建配置类，配置相关信息

3、配置 controller api 接口信息

4、配置实体类信息

5、测试运行

效果演示

完毕！

--------------------

## 1. Swagger ##

**简介**

一个 Api 框架  
RestFul Api 文档在线自动生成工具，Api 文档与 Api 定义同步更新  
直接运行，可以在线测试 Api 接口  
支持多种语言，如 java 、php 等  
官网：[https://swagger.io/][https_swagger.io]

## Spring Boot 整合 Swagger ##

### 1、引入依赖 ###

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
    </dependency>

### 2、创建配置类，配置相关信息 ###

/**
     * @Description 开启Swagger
     * @ClassName SwaggerConfig
     * @Author bug
     * @Date 2022/12/14 21:34
     * @Version 1.0
     */
    @Configuration
    //开启swagger注解
    @EnableOpenApi
    public class SwaggerConfig{
    
        //配置Swagger的Docket的实例，Swagger页面展示的信息，都在此处配置；如果要配置多个分组，就创建多个Docket实例
        @Bean
        public Docket getDocket() {
                    .pathMapping("/")
    				// 定义是否开启swagger，false为关闭，可以通过变量控制，线上关闭
    				.enable(enable)
    				//配置api文档元信息
    				.apiInfo(apiInfo())
    				// 选择哪些接口作为swagger的doc发布
    				.select()
    				.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).paths(PathSelectors.any())
    				//apis() 控制哪些接口暴露给swagger，
    				// RequestHandlerSelectors.any() 所有都暴露
    				// RequestHandlerSelectors.basePackage("**.**.*")  指定包位置
    				// withMethodAnnotation(ApiOperation.class)标记有这个注解 ApiOperation
    				.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
    				.paths(PathSelectors.any())
    				.build()
        }
    
        //配置Swagger的apiInfo
        private ApiInfo apiInfo() {
    
            Contact contact = new Contact("bug", "https://blog.csdn.net/weixin_52317961/article/details/128329739", "xxxxx.@qq.com");
    
            return new ApiInfo()
                    .title("swagger 文档标题")
                    .description("swagger 文档描述")
                    .version("1.0 swagger 文档版本")
                    .build();
            );
    
        }
    
    }

### 3、配置 controller api 接口信息 ###

/**
     * @Description 通过 用户id 获取用户信息
     * @author bug
     */
    @RestController
    @RequestMapping("/user")
    @Api(tags = {"用户接口tag"})
    public class UserController {
    
        @GetMapping("/{id}")
        @ApiOperation(value = "通过 用户id 获取用户信息")
        public User get(@PathVariable("id") Long id) {
            User user = new User();
            user.setId(1243245436543);
            user.setName("张三");
            user.setPassWord("123456");
            return user;
        }
    }

**注：在类上面添加 `@Api()` 注解，在接口方法上添加 `@ApiOperation()` 注解**

### 4、配置实体类信息 ###

/**
     * @author bug
     */
    @Data
    @ApiModel(description = "用户po")
    public class User {
        @ApiModelProperty(value = "用户id")
        private Long id;
        @ApiModelProperty(value = "用户名")
        private String username;
        @ApiModelProperty(value = "密码")
        private String password;
    }

**注：在类上面添加 `@ApiModel()` 注解，在属性上面添加 `@ApiModelProperty()` 注解**

### 5、测试运行 ###

启动服务，在浏览器中请求 `http://localhost:8080/swagger-ui/index.html`，结果如下

### 效果演示 ###

![84b83da992474af9a6b8eb9a8efe3190.png][]

![4c86d401dfe646bf8d967c5064b54064.png][]

![6c14fdfb415047159260ffe58c496744.png][]

## 完毕！ ##

[https_swagger.io]: https://swagger.io/
[84b83da992474af9a6b8eb9a8efe3190.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/80a9b8e7999940938c35b499d4faf151.png
[4c86d401dfe646bf8d967c5064b54064.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/2f701ddf47a54f03a25f2cc1e79036da.png
[6c14fdfb415047159260ffe58c496744.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/20c8232cc537414fad7110eb38670ef5.png