调用服务但 return 代码的描述与我明确定义的不匹配
Calling a service but description of the return code does not match what I define explicitly
我正在使用 OpenAPI (Swagger) 定义 Web 服务。
在响应部分,我明确定义了以下代码
responses:
'200':
description: Your order has been placed
content: ...
但是,当我调用该服务时,它returns“200 OK”,这是一个标准的 http 状态代码描述,而不是我明确定义的描述
根据此处 https://swagger.io/docs/specification/describing-responses/,它表示“如果使用显式代码定义响应范围,则显式代码定义优先于该代码的范围定义。”
我miss/misunderstand有什么事吗?
OpenAPI 定义中的 description
字段是仅用于文档目的的元数据。
此描述与 HTTP 响应中的 status text (aka reason-phrase
) 值无关,例如“HTTP/1.1 200 OK”中的“OK”。大多数 servers/frameworks 使用常见的状态文本,例如“200 OK”或“403 Forbidden”。
我正在使用 OpenAPI (Swagger) 定义 Web 服务。
在响应部分,我明确定义了以下代码
responses:
'200':
description: Your order has been placed
content: ...
但是,当我调用该服务时,它returns“200 OK”,这是一个标准的 http 状态代码描述,而不是我明确定义的描述
根据此处 https://swagger.io/docs/specification/describing-responses/,它表示“如果使用显式代码定义响应范围,则显式代码定义优先于该代码的范围定义。”
我miss/misunderstand有什么事吗?
OpenAPI 定义中的 description
字段是仅用于文档目的的元数据。
此描述与 HTTP 响应中的 status text (aka reason-phrase
) 值无关,例如“HTTP/1.1 200 OK”中的“OK”。大多数 servers/frameworks 使用常见的状态文本,例如“200 OK”或“403 Forbidden”。