Как определить схему ошибок с помощью Spring Boot Open API 3?

Question

Я использую Spring Boot и Spring Rest Приложение. В этом примере я мигрирую из Swagger2 в Open API 3.

У меня ниже @APiResponse, который возвращает 500 кодов ошибок, и я определяю объект ErrorResource для него. Я не уверен, как определить схему ошибки в этой аннотации для того же?

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

Answer 1

Вы добавляете реализацию схемы ваших ErrorDetails в атрибут содержимого. Например:

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

Вы можете посмотреть документацию по чванству:

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