1
2
3
4
5
6
7
8
9
10
11
<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
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
package com.nobody.config;
​
import java.util.ArrayList;
import java.util.List;
​
import org.springframework.beans.factory.annotation.Value;
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.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
​
@Configuration
@EnableSwagger2
public class Swagger2Config {
​
    @Value("${swagger.enable:true}")
    private boolean swaggerEnable;
​
    @Bean
    public Docket createApi() {
        // 全局参数
        List<Parameter> pars = new ArrayList<>();
        return new Docket(DocumentationType.SWAGGER_2).enable(swaggerEnable).apiInfo(apiInfo())
                .select().apis(RequestHandlerSelectors.basePackage("com.nobody"))
                .paths(PathSelectors.any()).build().globalOperationParameters(pars);
    }
​
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("XX服务后端API").description("XX服务专用API，其他系统请勿调用！")
                .version("1.0").termsOfServiceUrl("https://nobody.com")
                .contact(new Contact("陈皮", "https://nobody.com", "chenpi@qq.com")).build();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package com.nobody.dto;
​
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
​
/**
 * @Description
 * @Author Mr.nobody
 * @Date 2021/3/28
 * @Version 1.0
 */
@ApiModel(value = "管理员实体")
@Data
public class AdminDTO {
    @ApiModelProperty(value = "用户ID", required = true, example = "1548w4dwf7as1a21cv4")
    private String personId;
    @ApiModelProperty(value = "用户名", example = "陈皮")
    private String name;
    @ApiModelProperty(value = "用户年龄", required = true, example = "18")
    private Integer age;
}

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
package com.nobody.controller;
​
import com.nobody.dto.AdminDTO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.*;
​
import java.util.ArrayList;
import java.util.List;
/**
 * @Description
 * @Author Mr.nobody
 * @Date 2021/3/27
 * @Version 1.0
 */
@Api(tags = {"管理员相关"})
@RestController
@RequestMapping("admin")
public class AdminController {
​
    @ApiOperation(value = "添加管理员", notes = "注意：只有管理员权限才能添加管理员", produces = "application/json",
            consumes = "application/json")
    @PostMapping("add")
    public AdminDTO add(@ApiParam(value = "参数体", required = true) @RequestBody AdminDTO adminDTO) {
        return adminDTO;
    }
​
    @ApiOperation(value = "管理员列表", notes = "注意：只有管理员权限才能获取管理员列表", produces = "application/json")
    @GetMapping("list")
    public List<AdminDTO> list(
            @ApiParam(value = "页码，从1开始，1，2，3...", required = true,
                    example = "1") @RequestParam Integer pageIndex,
            @ApiParam(value = "页量", required = true,
                    example = "10") @RequestParam Integer pageSize) {
        return new ArrayList<>();
    }
}

1
2
3
4
5
6
<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-spring-boot-starter</artifactId>
  <version>3.0.2</version>
</dependency>