SpringBoot+Swagger2实现可视化API文档流程

痛定思痛。 2023-10-18 20:27 46阅读 0赞

## 场景 ##

swagger官网：

[https://swagger.io/][https_swagger.io]

### 效果 ###

会将所有的接口Controller可视化显示

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70][]

点击其中的Controller显示具体的接口方法，左边是请求的方式，中间是接口的url，右边是接口说明。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 1][]

点击具体的方法，显示方法说明和参数说明

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 2][]

输入相应的参数，点击Execute，可以在线测试接口。

可以查看接口返回数据。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 3][]

## 实现 ##

### 添加swagger2依赖 ###

打开项目的pom.xml

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.8.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.8.0</version>
            </dependency>

### 新建Swagger2配置类 ###

在项目启动类的同级，新建Swagger2的配置类Swagger2

package com.ws.api;
    
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @Configuration
    @EnableSwagger2
    public class Swagger2 {
    
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.ws.api.sys.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("API接口")
                    .description("")
                    .version("1.0")
                    .build();
        }
    
    }

注：

1.通过@Configuration注解来让Spring加载该类配置。

2.通过@EnableSwagger2注解启用Swagger2。

3. .apis(RequestHandlerSelectors.basePackage("com.ws.api.sys.controller"))来指定扫描Controller的包。

### 为接口添加文档说明 ###

找到Controller下的具体的接口的方法。

#### 为接口API添加说明和说明信息 ####

@ApiOperation(value="生成单件质检单", notes="上位机扫码，生成单件质检单")

#### 为接口添加参数说明 ####

@ApiImplicitParam(name = "trayCode", value = "托盘编码", required = true, dataType= "String")

多个参数的写法：

@ApiImplicitParams({
                @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
                @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
       })

#### 完整示例代码： ####

@Description("扫码生成单件质检单")
        @RequestMapping(value="/generatingSingleJianQualityTestOrder",method =RequestMethod.POST)
        @ResponseBody
        @ApiOperation(value="生成单件质检单", notes="上位机扫码，生成单件质检单")
        @ApiImplicitParam(name = "trayCode", value = "托盘编码", required = true, dataType = "String")
        public  Json generatingSingleJianQualityTestOrder(String trayCode) {
            return this.wmsMasterCleanFinishService.generatingSingleJianQualityTestOrder(trayCode);
       }

### 访问在线API ###

启动SpringBoot项目，在浏览器中输入：

[http://localhost:8080/swagger-ui.html][http_localhost_8080_swagger-ui.html]

注意将项目端口号8080改成自己项目的端口号。

[https_swagger.io]: https://swagger.io/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190625134757339.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20190625134849111.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/2019062513490175.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20190625134913150.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[http_localhost_8080_swagger-ui.html]: http://localhost:8080/swagger-ui.html