使用Markdown进行说明
Postman支持 Markdown 作为对集合中的请求,集合和文件夹进行文字描述的方式。您甚至可以嵌入屏幕截图和其他图像以获得更多描述性的方式。
回顾Markdown参考 API文档。
Postman在以下地方支持Markdown:

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

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

注意:路径变量和URL参数的说明目前未显示在文档中。
您可以通过单击编辑器右上角的省略号(...)来隐藏和显示数据编辑器中的值和描述列,并取消选中要隐藏的列。

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

网友评论