Question

使用 Markdown 进行说明

Postman 支持 Markdown 作为对 集合中的 请求， 集合 和 文件夹 进行文字描述的方式。您甚至可以嵌入屏幕截图和其他图像以获得更多描述性的方式。

回顾 Markdown 参考 API 文档。

Postman 在以下地方支持 Markdown：

在请求构建器中，请求描述可以用 Markdown 来美化。

请求描述

集合详细信息视图可以在集合和文件夹的描述中使用 Markdown 来美化。

集合详细视图

对于公共或内部 API 文档 ，自动生成的 API 描述将通过 Markdown 以精简和精确的方式进行美化。

自动生成文档

---

请求属性的描述

数据编辑器中 的描述列使您的请求更容易理解。您可以为 Postman 应用程序中的每个查询参数，路径变量，header 和 body（表单数据和 urlencoded）添加注释和详细信息。

例如，指定元素是必需的还是可选的，指示其接受的数据类型，或使用其他可替代的术语为正在处理您的请求的开发人员提供额外的说明。

数据编辑器参数

对于 Postman 用户发布内部或公共 API 文档，这些描述显示在该集合的 自动生成的文档 中。

自动生成文档中的参数

注意：路径变量和 URL 参数的说明目前未显示在文档中。

您可以通过单击编辑器右上角的省略号（...）来隐藏和显示数据编辑器中的值和描述列，并取消选中要隐藏的列。

取消选中参数

注意：描述是请求的元数据， 不会 与您的 HTTP 请求一起发送。当您将鼠标悬停在描述列的标题上时，会显示此提醒。

鼠标悬停参数