body里写注释 postman_Postman中文文档——使用Markdown添加描述

使用Markdown进行说明

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

Postman在以下地方支持Markdown：

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

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

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

请求属性的描述

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

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

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

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

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

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