Spring Boot：整合Swagger文档

秒速五厘米 2023-06-05 15:54 33阅读 0赞

### 综合概述 ###

spring-boot作为当前最为流行的Java web开发脚手架，越来越多的开发者选择用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的web端（b/s），也会服务于移动端。在实际开发过程中，这些接口还要提供给开发测试进行相关的白盒测试，那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。

假如你已经对传统的wiki文档共享方式所带来的弊端深恶痛绝，那么尝试一下Swagger2 方式，一定会让你有不一样的开发体验。

使用 Swagger 集成文档具有以下几个优势：

功能丰富 ：支持多种注解，自动生成接口文档界面，支持在界面测试API接口功能；

及时更新 ：开发过程中花一点写注释的时间，就可以及时的更新API文档，省心省力；

整合简单 ：通过添加pom依赖和简单配置，内嵌于应用中就可同时发布API接口文档界面，不需要部署独立服务。

### 实现示例 ###

1.添加相关依赖

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

2.添加配置类

添加一个swagger配置类，在工程下新建config包，添加一个SwaggerConfig配置类

SwaggerConfig.java

3.添加控制器

@RestController
    @RequestMapping("/httpclient")
    public class HttpClientController {
    @Resource
    private HttpClientApiUtils httpClientApiUtils;
    //先发送http请求，看是否可以请求成功
    @RequestMapping(value = "/client",method = RequestMethod.GET)
    @ApiOperation(value = "http请求校验接口”)//接口描述
    public String test() throws Exception {
        String s = httpClientApiUtils.doGet("http://www.baidu.com");
        System.err.println(s);
        return "hello";
    }

重启项目后，网页输入[http://localhost:8080/swagger-ui.html\#/][http_localhost_8080_swagger-ui.html]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMjI3Mjgx_size_16_color_FFFFFF_t_70][]

测试

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMjI3Mjgx_size_16_color_FFFFFF_t_70 1][]

### 常用注解说明 ###

swagger 通过注解接口生成文档，包括接口名，请求方法，参数，返回信息等。

@Api: 修饰整个类，用于controller类上

@ApiOperation: 描述一个接口，用户controller方法上

@ApiParam: 单个参数描述

@ApiModel: 用来对象接收参数,即返回对象

@ApiModelProperty: 对象接收参数时，描述对象的字段

@ApiResponse: Http响应其中的描述，在ApiResonse中

@ApiResponses: Http响应所有的描述，用在

@ApiIgnore: 忽略这个API

@ApiError: 发生错误的返回信息

@ApiImplicitParam: 一个请求参数

@ApiImplicitParam: 多个请求参数

添加token的请求参数

package com.it.java.philology.config;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.ParameterBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.schema.ModelRef;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Parameter;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    import java.util.ArrayList;
    import java.util.List;
    /**
     * <P>
     *     Swagger配置类
     * </P>
     * @Author 王文龙
     * @Date 2019-10-09 14:04
     */
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        @Bean
        public Docket createRestApi(){
            // 添加请求参数，我们这里把token作为请求头部参数传入后端
            ParameterBuilder parameterBuilder = new ParameterBuilder();
            List<Parameter> parameters = new ArrayList<Parameter>();
            parameterBuilder.name("token").description("令牌")
                    .modelRef(new ModelRef("string")).parameterType("header").required(false).build();
            parameters.add(parameterBuilder.build());
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                    .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any())
                    .build().globalOperationParameters(parameters);
    //        return new Docket(DocumentationType.SWAGGER_2)
    //                .apiInfo(apiInfo())
    //                .select()
    //                .apis(RequestHandlerSelectors.any())
    //                .paths(PathSelectors.any()).build();
        }
        private ApiInfo apiInfo(){
            return new ApiInfoBuilder()
                    .title("Kitty API Doc")
                    .description("This ni a restful api document of kitty")
                    .version("1.0")
                    .build();
        }
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMjI3Mjgx_size_16_color_FFFFFF_t_70 2][]

[http_localhost_8080_swagger-ui.html]: http://localhost:2413/swagger-ui.html#/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMjI3Mjgx_size_16_color_FFFFFF_t_70]: /images/20230601/934611f83cff4e20ae0b0ba03122e233.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMjI3Mjgx_size_16_color_FFFFFF_t_70 1]: /images/20230601/4ee15ee31d874ef3a238307f43fd431c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyMjI3Mjgx_size_16_color_FFFFFF_t_70 2]: /images/20230601/e3c0c430f1e948b0b9bc683abac7733b.png