Spring Boot之一 配置Swagger

集成Swagger插件

1. 添加Swagger2依赖

<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.6.1</version>
</dependency>
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.6.1</version>
</dependency>
<dependency>  
     <groupId>com.fasterxml.jackson.core</groupId>  
     <artifactId>jackson-core</artifactId>  
     <version>2.6.5</version>  
</dependency>  
<dependency>  
     <groupId>com.fasterxml.jackson.core</groupId>  
     <artifactId>jackson-databind</artifactId>  
     <version>2.6.5</version>  
</dependency>  
<dependency>  
     <groupId>com.fasterxml.jackson.core</groupId>  
     <artifactId>jackson-annotations</artifactId>  
     <version>2.6.5</version>  
</dependency>

2. 创建Swagger2配置类
3. 编写swagger注解

配置类

配置

@Configuration      //让Spring来加载该类配置
@EnableWebMvc       //启用Mvc，非springboot框架需要引入注解@EnableWebMvc
@EnableSwagger2     //启用Swagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()).select()
                //扫描指定包中的swagger注解
                //.apis(RequestHandlerSelectors.basePackage("com.xia.controller"))
                //扫描所有有注解的api，用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("基础平台 RESTful APIs")
                .description("基础平台 RESTful 风格的接口文档，内容详细，极大的减少了前后端的沟通成本，同时确保代码与文档保持高度一致，极大的减少维护文档的时间。")
                .termsOfServiceUrl("http://xiachengwei5.coding.me")
                .contact("Xia")
                .version("1.0.0")
                .build();
    }
}

swagger-ui页面

在swagger的配置类中继承WebMvcConfigurationSupport，实现addResourceHandlers方法，设置静态资源可访问;

swagger-ui.html 在META-INF/resources目录下

@Configuration
@EnableSwagger2
public class WebMvcConfg extends WebMvcConfigurationSupport {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

配置swagger后静态资源目录无法访问,如下解决

@Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 解决静态资源无法访问
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/static/");
        // 解决swagger无法访问
        registry.addResourceHandler("/doc.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

参考：https://www.cnblogs.com/jpfss/p/12097193.html

分组

编写多个 @Bean方法，即是多个分组

1. 不同类型的控制器在不同包下

系统类
    com.ai.web.sys
业务类
    com.ai.web.business

2. 根据包名进行分组

    @Bean
    public Docket sysApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        if (StringUtils.isNotBlank(swaggerHost)) {
            docket = docket.host(swaggerHost);//配置文件
        }
        docket.enable(enableSwagger);//配置文件
        docket = docket.groupName("系统接口") //分组名称
                .useDefaultResponseMessages(false).select().apis(RequestHandlerSelectors.basePackage("com.ai.web.sys"))//包名
                .paths(PathSelectors.any()).build().apiInfo(apiInfo());
        return docket;
    }


    @Bean
    public Docket businessApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        if (StringUtils.isNotBlank(swaggerHost)) {
            docket = docket.host(swaggerHost);//配置文件
        }
        docket.enable(enableSwagger);//配置文件
        docket = docket.groupName("业务接口") //分组名称
                .useDefaultResponseMessages(false).select().apis(RequestHandlerSelectors.basePackage("com.ai.web.business"))//包名
                .paths(PathSelectors.any()).build().apiInfo(apiInfo());
        return docket;
    }

Swagger注解

@Api：用在请求的类上，表示对类的说明
tags=“说明该类的作用，可以在UI界面上看到的注解”
value=“该参数没什么意义，在UI界面上也看到，所以不需要配置”

@ApiOperation：用在请求的方法上，说明方法的用途、作用
value=“说明方法的用途、作用”
notes=“方法的备注说明”

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· body（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer”
defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性

@ApiOperationSupport(order =1)

接口排序显示：
打开swagger文档，文档管理-个性化设置，启用knife4j提供的增强功能

推荐文章

Spring boot集成Swagger，并配置多个扫描路径

SpringMVC集成Swagger插件以及Swagger注解的简单使用

swagger2 注解说明 ( @ApiImplicitParams )