在起草API蓝图文档时，我如何对响应进行注释？
在起草API蓝图文档时，我如何对响应进行注释？
提问于 2013-12-24 21:34:48
我想注释一些错误响应，如下所示：
* Response 412
If the Etag supplied in `If-Match` didn’t match.
* Response 428
If the request didn’t include the header `If-Match`.但是解析器(雪崩)似乎将注释解释为响应体。
我怎样才能注释这些反应，让雪崩明白它们是注释呢？
回答 1
Stack Overflow用户
回答已采纳
发布于 2013-12-24 21:38:55
我想明白了:我需要在响应中添加一个空的Body部分，如下所示：
* Response 204
The request succeeded; there’s no need to transfer a representation of the new state of the resource, as the resource no longer exists.
* Body
* Response 412
If the Etag supplied in `If-Match` didn’t match.
* Body然后根据需要对其进行分析：
responses:
- name: 204
description: "The request succeeded; there’s no need to transfer a representation of the new state of the resource, as the resource no longer exists.\n"
headers:
body:
schema:
- name: 412
description: "If the Etag supplied in `If-Match` didn’t match.\n"
headers:
body:
schema:
- name: 428
description: "If the request didn’t include the header `If-Match`.\n"
headers:
body:
schema:页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/20766980
复制相关文章
相似问题
腾讯云开发者
