Spring Boot RESTful API Open API (Swagger) 文档标注 (Annotation)

我们可以通过给 Spring Boot 项目增加以下的依赖项来给 RESTful 控制器 (Controllers) 增加 Open API 文档页面，但是这只解决了有没有的问题，那么我们如何给每一个 REST API 增加更详细的说明呢？

REST 方法

简单来说我们可以使用 @Operation 标注, @Parameter 标注以及 @ApiResponses 标注来给我们的每个 API 增加更详细的说明，具体示例如下：

@DeleteMapping("{id}")
@Operation(description = "删除指定的 Customer 记录")
@ApiResponses(
        value = {
   
   
                @ApiResponse(responseCode = "404", description = "不能找到指定 ID 的 Customer 记录")