Java和OpenAPI-根据响应代码返回不同的负载

Question

在开始之前：我查看了以下链接，但没有一个与我的问题相匹配：

• Swagger-指定可选对象属性或多个响应
• Swagger；根据可选参数指定两个具有相同代码的响应
• Swagger-指定可选对象属性或多个响应

因此，我有一个endpoint的OpenAPI 3定义，该endpoint为成功调用返回给定的有效负载（例如，200ok）。但是，对于不成功的调用（例如，408冲突），我希望返回完全不同的错误负载。

你可以看到下面的定义：

openapi: 3.0.1

info:
  title: Dogs
  description: API to add dogs into a database
  version: 0.0.1

paths:
  /dog:
    post:
      description: Saves a dog into the database

      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Dog"

      responses:
        201:
          description: A dog was added to the system
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Dog"

        400:
          description: This dog already exist in the system
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

components:
  schemas:
    Dog:
      type: object
      properties:
        name:
          type: string
          description: Name of the dog
          example: "barky"

    Error:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable code of the error.
          example: "Already Exists"

        message:
          type: string
          description: A Human-readable error message.
          example: "Empty string is not a valid name for a dog"

由此，我生成了一个Spring代码（目前使用的是Swagger编辑器）。与定义关联的方法签名如下所示：

ResponseEntity<Dog> dogPost(@ApiParam(value = ""  )  @Valid @RequestBody Dog body);

因此，除非在异常中抛出异常并捕获，否则我不能返回此函数中的错误对象，因为无效输入的操作也不例外，因此我认为这是一个错误的做法。

有没有一种方法可以很好地解决这个问题，而不会抛出异常并在函数范围之外捕获它？

Answer 1

有很多方法可以通过Spring Boot实现这种需求。请参见使用它们中的一个异常代码https://www.baeldung.com/exception-handling-for-rest-with-spring更多信息），但这确实是在控制器本身之外处理的。该系统的优点是，您可以在1个位置实现任何异常到错误对象的转换，而不是单独实现每个控制器方法。

也就是说，如果您确实希望在控制器本身中处理它，您可以执行以下操作：

@PostRequest("/dog")
public ResponseEntity<?> createDog(@Valid @RequestBody Dog dog) {
    if( !service.doesDogAlreadyExist(dog) ) {
      Dog dog = service.createDog(dog);
      return ResponseEntity.ok(dog).build();
    } else {
      return ResponseEntity.status(HttpStatus.CONFLICT)
                           .body(/* error object here */)
    }
}