潘鑫博客

Swagger

11/7/2022 swaggerjava

# 前言

前后端分离项目，API文档，各自开发，互不干扰，不过有代码入侵。

# 添加依赖

注意版本

<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>
1
2
3
4
5
6
7
8
9
10

# 配置

package com.zr.config;

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zr.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     *  构建api文档的详细参数
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot项目API文档")
                .contact(new Contact("潘鑫","https://panxin.me","email@panxin.me"))
                .version("1.0")
                .description("项目API说明文档")
                .build();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# 注解

@Api("用户控制类")

# 放行地址

# 效果

/swagger-ui.html

注意： 不要使用requestMapping，最好指定是post还是get，会显示7个请求： GET、POST、PUT、DELETE、PATCH、OPTIONS

# 2. api

实体类属性，一般在VO上标注，controller层入参的实体类上标注 @ApiModelProperty( value = "当前页码", example required = true //必填, )

# 3. UI增强插件

# 依赖

com.github.xiaoymin swagger-bootstrap-ui 1.8.9

配置类添加注解

package com.zr.config;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zr.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     *  构建api文档的详细参数
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot项目API文档")
                .contact(new Contact("潘鑫","https://panxin.me","email@panxin.me"))
                .version("1.0")
                .description("项目API说明文档")
                .build();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

接口描述 根据查询条件返回用户列表 @ApiOperation(value = "查询用户",notes = "根据查询条件返回用户列表")