如何在springdoc模式中描述标准Spring错误响应？

Question

SpringBoot应用程序在出现未处理错误时的默认服务器响应为

{
    "timestamp": 1594232435849,
    "path": "/my/path",
    "status": 500,
    "error": "Internal Server Error",
    "message": "this request is failed because of ...",
    "requestId": "ba5058f3-4"
}

我想在应用程序路由的Springdoc注释中描述它。

假设有一个标准类DefaultErrorResponse（只是一个模拟名称），它可能如下所示：

@Operation(
  // ... other details
  responses = {
    // ... other possible responses
    @ApiResponse(
      responseCode = "500",
      content = @Content(schema = @Schema(implementation = DefaultErrorResponse.class)))
  }
)

在更糟糕的情况下，这样的类不存在，Spring只在引擎盖下使用Map来创建响应。那么这个注释将更加详细，包括明确提到响应中包含的每个字段。

显然，对于大多数路由，这一部分@ApiResponse（responseCode=“500”，…是相同的，最好减少重复。

在文档中介绍默认错误响应的正确方式是什么？

Answer 1

对于错误处理，可以将@RestControllerAdvice与@ExceptionHandler组合使用，以重构错误处理。

springdoc openapi会自动扫描这些spring注释。无需添加任何额外的招摇过市注释。