Swagger 文档 - 单个 http 响应的多个错误代码

Question

我正在尝试记录一个始终返回自定义响应代码和相关描述的模型。对于单个 HTTP 响应代码，可能有多个自定义响应代码。例如，400 响应可能包括：

+===========+======+=============+
| HTTP Code | Code | Description |
+===========+======+=============+
|       400 |    1 | Error 1     |
+-----------+------+-------------+
|       400 |    2 | Error 2     |
+-----------+------+-------------+
|       400 |    3 | Error 3     |
+-----------+------+-------------+

我可以记录 400 状态返回一个具有“代码”和“描述”的“错误”对象。但如果可能的话，我想在文档中包含所有自定义状态代码。是否可以？如果是这样，我将如何去做？

Answer 1

对于现在面临这个问题的人来说，我是这样解决的：

              '422':
                description: 'Unprocessable Entity'
                content:
                    application/json:
                        schema:
                          oneOf:
                            - $ref: '#/components/schemas/SchemaForErrror1'
                            - $ref: '#/components/schemas/SchemaForErrror2'

                        examples:
                          Error1:
                            $ref: '#/components/examples/ExampleForError1'
                          Error2:
                            $ref: '#/components/examples/ExampleForError2'