如何在 OpenAPI 中引用响应组件?
How to reference response components in OpenAPI?
我正在为我的 API 写一个 OpenAPI 定义。
我正在使用 components
进行响应,但是当我尝试引用这些组件时 Swagger Editor 显示错误:
引用响应组件的正确方法是什么?
引用响应组件的正确方法是:
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
也就是说,responses
是一个 map(不是 array/list),其中键是 HTTP 状态代码,值是响应定义。
我正在为我的 API 写一个 OpenAPI 定义。
我正在使用 components
进行响应,但是当我尝试引用这些组件时 Swagger Editor 显示错误:
引用响应组件的正确方法是什么?
引用响应组件的正确方法是:
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
也就是说,responses
是一个 map(不是 array/list),其中键是 HTTP 状态代码,值是响应定义。