Postman编辑文档详细信息图文教学

postman windows是postman这款强大网页调试工具的windows客户端，提供功能强大的 Web API & HTTP 请求调试。它能够发送任何类型的HTTP 请求 (GET，HEAD，POST，PUT..)，附带任何数量的参数+ headers。

使用帮助

在您的文档中包含详细信息

您的文档将自动包含您的请求的详细信息，以及各种客户端语言的示例代码。每个集合/请求列表都指明了方法、所需的授权类型、URL、描述、标头、请求和响应结构以及示例。在私有和公共文档中，标题、参数和请求正文中的所有键值对都将为每个请求显示。

私人文档包括共享相关集合的链接，公共文档包括在 Postman 中运行按钮，允许查看者将集合直接导入 Postman 以尝试您的请求。您的文档页面的结构将反映您收藏中的文件夹和请求。

您可以使用Markdown向您的描述添加详细信息。Postman 支持GitHub 风格的 Markdown，因此您可以包含各种类型的内容，例如列表、表格、图像和链接。

Postman编辑文档详细信息图文教学图2

访问文档视图

默认情况下，您的文档是私密的，只有您与之共享收藏集的人才能查看。如果您发布文档，任何知道链接的人都可以在浏览器中查看它。

有关访问私有和公共文档的更多信息，请参阅查看文档。

您的文档每个月都会获得多次免费查看，除此之外还取决于您的Postman 计划。您可以通过Postman API或帐户使用页面查看您的使用限制。

文档环境

您可以使用环境来设置将在您的文档中可用的变量。任何查看私人文档的人都可以访问与他们共享的环境。对于公共文档，您可以选择在发布过程中共享的环境——这将使任何查看已发布文档链接的人都可以使用该环境。

Postman编辑文档详细信息图文教学图3

将环境与您的文档相关联意味着您的请求引用的任何环境变量的值将自动填充到文档内容中。使用您文档中的Run in Postman按钮的任何人也可以在将集合导入 Postman 时访问共享环境。

要在文档中使用变量值，请创建或选择一个环境。

如果您还没有这样做，请添加新变量。当您在请求中引用变量时，所选环境中的值将与您的文档一起自动发布。

这意味着任何查看您的文档的人都会看到变量值以及相关环境。您可以在描述文本中引用变量以显示文档中的值。如果有人使用您的文档中的Run in Postman按钮导入集合，他们也会导入环境和变量。