Question

我想为我的错误400提供一系列自定义代码和消息，但是找不到任何方法。理想情况是：

Error:
  type: object
  enum:
    - [E01, 'Error1']
    - [E02, 'Error2']

依此类推

Answer 1

因此，我不确定此处的枚举对您有帮助。如果您看一下官方文档，枚举只是字符串，而不是对象https://swagger.io/docs/specification/data-models/enums/。

所以我的建议是使用：

ErrorType:
 type: object
 properties:
   code: 
     type: integer
   name:
     type: string
 example:   # Sample object
     code: 10
     name: Custom Error

 Error:
  type: object
  properties:
     errors:
       oneOf:
         - $ref '#/ErrorType'
         - etc...
or directly without properties
Error:
  type: object
  oneOf:
   - $ref '#/ErrorType'
   - etc...

您可以在官方页面https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/

中查看更多示例

OpenApi：如何描述错误代码和消息？

1 个答案: