Swagger管理api文档

Swagger 的优势

• 支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档。

集成 Swagger 管理 API 文档

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.7.1.RELEASE</version>
</dependency>

在启动类中使用 @EnableSwagger2Doc 开启 Swagger，代码如下所示。

1. @EnableSwagger2Doc
2. @SpringBootApplication
3. public class AuthApplication {
4. public static void main(String[] args) {
5. SpringApplication.run(AuthApplication.class, args);
6. }
7. }

2）使用 Swagger 生成文档

Swagger 是通过注解的方式来生成对应的 API，在接口上我们需要加上各种注解来描述这个接口，关于 Swagger 注解的使用在教程后面会有详细讲解，本节只是带大家快速使用 Swagger，使用方法代码如下所示。

1. @ApiOperation(value = "新增用户")
2. @ApiResponses({ @ApiResponse(code = 200, message = "OK", response = UserDto.class) })
3. @PostMapping("/user")
4. public UserDto addUser(@RequestBody AddUserParam param) {
5. System.err.println(param.getName());
6. return new UserDto();
7. }

参数类定义代码如下所示。

1. @Data
2. @ApiModel(value = "com.biancheng.auth.param.AddUserParam", description = "新增用户参数")
3. public class AddUserParam {
5. @ApiModelProperty(value = "ID")
6. private String id;
8. @ApiModelProperty(value = "名称")
9. private String name;
11. @ApiModelProperty(value = "年龄")
12. private int age;
13. }

在线测试接口

接口查看地址可以通过服务地址 /swagger-ui.html 来访问