如何为仅返回状态码无响应体的API路径编写YAML示例?
解决PUT请求201无响应体的YAML配置问题
针对返回201状态码且无响应体的PUT请求,你之前的body: type: null写法不符合规范,所以无法生效。以下是正确的YAML配置示例:
标准OpenAPI规范写法
paths: /target-endpoint: put: summary: 示例PUT请求 requestBody: # 按需填写你的请求体结构,比如: content: application/json: schema: type: object properties: key: type: string responses: '201': description: 请求成功,无返回内容 content: {} # 明确声明无响应体内容
简化写法(适配部分轻量API文档工具)
如果无需严格遵循OpenAPI规范,也可以直接省略响应体相关配置,仅保留状态码和描述:
responses: '201': description: 请求成功,无返回内容
部分工具也支持用body: {}表示空响应体,但content: {}是兼容性更广的通用写法,能确保各类API解析工具正确识别这是无响应体的返回。
内容的提问来源于stack exchange,提问作者Gagandeep Sharma
相关产品推荐
相关产品推荐

