Java程序设计：spring boot（8）——API ⽂档构建⼯具 - Swagger2

   目录

1 环境整合配置

2 Swagger2 常⽤注解说明

2.1 @Api

2.2 @ApiOperation

2.3 @ApiImplicitParams

2.4 @ApiResponses

2.5 @ApiModel

3 用户模块注解配置

3.1 Controller 使用注解

3.2 JavaBean 使用注解

4 Swagger2 接⼝⽂档访问

---

       由于 Spring Boot 能够快速开发、便捷部署等特性，通常在使⽤ Spring Boot 构建 Restful 接⼝应⽤ 时考虑到多终端的原因，这些终端会共⽤很多底层业务逻辑，因此我们会抽象出这样⼀层来同时服务于 多个移动端或者Web 前端。对于不同的终端公⽤⼀套接⼝ API 时，对于联调测试的时候就需要知道后端 提供的接⼝ API列表⽂档，对于服务端开发⼈员来说就需要编写接⼝⽂档，描述接⼝的调⽤地址、参数 结果等，这⾥借助第三⽅构建⼯具 Swagger2 来实现 API ⽂档⽣成功能。

1 环境整合配置

pom.xml 依赖添加：

<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.xxxx.springboot.controller"))
 .paths(PathSelectors.any())
 .build();
 }
 private ApiInfo apiInfo() {
 return new ApiInfoBuilder()
 .title("⽤户管理接⼝API⽂档")
 .version("1.0")
 .build();
 }
}

2 Swagger2 常⽤注解说明

2.1 @Api

@Api：⽤在请求的类上，说明该类的作⽤
 tags="说明该类的作⽤"

@Api(tags="APP⽤户注册Controller")

2.2 @ApiOperation

@ApiOperation："⽤在请求的⽅法上，说明⽅法的作⽤"
 value="说明⽅法的作⽤"
 notes="⽅法的备注说明"

@ApiOperation(value="⽤户注册",notes="⼿机号、密码都是必填项，年龄是选填项，但必须是数
字")

2.3 @ApiImplicitParams

@ApiImplicitParams：⽤在请求的⽅法上，包含⼀组参数说明
 @ApiImplicitParam