如何使用Spring Boot Open API 3定义错误模式？

Question

我正在使用 Spring Boot和Spring Rest 应用程序。在此示例中，我从Swagger2迁移到Open API3。

我在@APiResponse下面，该代码返回500个错误代码，并为该对象定义ErrorResource对象。我不确定该如何在这个别名中定义错误模式？

@ApiResponses(value = { @ApiResponse(responseCode = "200", description = "For Success"),
        @ApiResponse(responseCode = "500", description = "Internal Server Error") })

Answer 1

您可以在content属性上添加ErrorDetails的模式实现。 例如：

@ApiResponse(responseCode = "500", description = "Internal Server Error", content = @Content(mediaType = "application/json",
        schema = @Schema(implementation = ErrorDetails.class)))

您可以查看swagger文档：

• https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations