springboot整合API 文档构建工具-Swagger2

第一步：
添加相关依赖坐标

<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>

第二步:添加配置类

@Configuration
@EnableSwagger2
public class Swagger2 {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
.apis(RequestHandlerSelectors.basePackage("com.zks.springboot.controller"))
        .paths(PathSelectors.any())
        .build();
  }
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("用户管理接口API文档参考")
        .version("1.0")
        .build();
  }
}

第三步：用常用注解标注源文件信息
1.@Api tags=""
用在请求的类上，说明该类的作用
2.@ApiOperation:用在请求的方法上，说明方法的作用
value=“说明方法的作用”
notes=“方法的备注说明”

3.@ApiImplicitParam这个注解是用在请求方法上，包含一组参数的说明。
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方

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