Swagger 是一个 API 文档生成工具,能够自动生成、展示和测试 API 接口的文档,简化开发人员编写接口文档的工作。在 Spring Boot 2.x 中,Swagger 接口主要分为以下几个分类。

1. 控制器 (Controller) 接口

控制器接口,即处理 HTTP 请求的接口,是 Swagger 文档中的主要部分。在 Spring Boot 2.x 中,可以通过使用注解 @ApiOperation 来指定接口的描述信息,通过注解 @ApiParam 来指定参数的描述信息,通过注解 @ApiResponse 来指定接口的返回结果。通过使用这些注解,可以很方便地为控制器接口生成详细的文档。

@RestController
@Api(tags = "用户管理")
@RequestMapping("/users")
public class UserController {

  @ApiOperation("获取用户列表")
  @GetMapping("/list")
  public List getUsers() {
    // 省略具体实现
  }

  @ApiOperation("创建用户")
  @PostMapping("/create")
  public String createUser(@ApiParam("用户名") @RequestParam String username,
                           @ApiParam("密码") @RequestParam String password) {
    // 省略具体实现
  }
}
Java

2. 数据实体 (Model) 类

数据实体类,即与数据库表结构对应的 Java 类,Swagger 可以自动生成数据实体类的文档。在 Spring Boot 2.x 中,只需要在实体类上添加 @ApiModel 注解,并使用 @ApiModelProperty 注解来指定字段的描述信息即可。Swagger 会根据这些注解自动生成数据实体类的文档。

@ApiModel("用户实体类")
public class User {

  @ApiModelProperty("用户ID")
  private Long id;
  
  @ApiModelProperty("用户名")
  private String username;

  @ApiModelProperty("密码")
  private String password;

  // 省略getter和setter方法
}
Java

3. 异常处理 (Handler) 类

异常处理类,即处理应用程序抛出的异常的类,是 Swagger 文档中的重要部分。在 Spring Boot 2.x 中,可以通过使用注解 @ExceptionHandler 来指定异常处理方法,并使用注解 @ApiResponses 来指定异常的处理结果。通过使用这些注解,可以为异常处理类生成详细的文档。

@RestControllerAdvice
public class GlobalExceptionHandler {

  @ExceptionHandler(UserNotFoundException.class)
  @ResponseStatus(HttpStatus.NOT_FOUND)
  @ApiOperation(" 用户不存在异常处理 ")
  @ApiResponse(code = 404, message = "用户不存在 ")
  public String handleUserNotFoundException(UserNotFoundException ex) {
    return ex.getMessage();
  }

  // 省略其他异常处理方法
}
Java

综上所述,Spring Boot 2.x 中的 Swagger 接口可以根据功能的不同进行分类,包括控制器接口、数据实体类和异常处理类等。使用 Swagger 可以方便地生成详细的接口文档,提高开发效率。