发布您的文档

发布您的文档可以让任何拥有文档链接和 Web 浏览器的人都可以使用它。发布您的文档以帮助世界各地的人们了解如何使用您的集合或与您的公共 API 交互。

公共文档自动包含已发布集合中每个请求或端点的详细信息，以及各种客户端语言的示例代码。当您修改您的收藏时，已发布的文档会自动与您的最新更改保持同步。进行更改后无需再次发布文档。

您的公共文档包括在 Postman 中运行按钮，因此用户可以直接在 Postman 中与您的集合或 API 进行交互。例如，查看从 Postman 集合发布的Postman API 文档。

内容

• 公开您的文档
• 添加自定义徽标
• 共享您的公共文档
• 更改发布设置
• 取消发布您的文档
• 下一步

公开您的文档

要发布文档，它必须是集合的一部分。您可以为您创建或有权编辑的任何集合发布文档。

要发布集合的文档：

1. 在左侧边栏中选择集合。

2. 选择集合旁边的三个点，然后选择查看文档。

3. 选择右上角的发布。

   

4. 根据需要更改任何发布设置：

   • 发布标签：选择一个或多个发布标签进行发布。用户可以查看每个选定版本的文档。
   • 环境：选择一个环境以在您的文档中发布环境变量。所有变量的初始值都与您的文档一起发布，因此请确保它们不包含敏感信息，例如密码或令牌。
   • 自定义域：选择要发布文档的自定义域。
   • 默认布局：为您的文档选择布局样式。双列在文档右侧的列中显示示例代码。单列显示每个请求下方的示例代码内联。
   • 标题背景颜色：为文档窗口顶部的标题指定颜色（十六进制格式）。
   • 代码背景颜色：指定示例代码块的颜色（十六进制格式）。
   • 突出显示颜色：指定超链接的颜色（十六进制格式）。
   • 移动到公共工作区：（可选）选择一个可用的公共工作区以将集合移动到。这将使该集合及其文档可在公共 API 网络上被发现。

5. 要查看使用当前设置的文档的外观，请选择Preview Documentation。当您更改设置时，预览会自动更新。

   如果 Postman 检测到可能是敏感令牌或其他机密，则会在预览窗口顶部显示警告。Postman 还会突出显示该令牌，以便您可以在发布之前将其从文档中删除。

6. 完成更改设置后，选择Publish Collection。您可以在提供的 URL 上查看您的公共文档。

添加自定义徽标

如果您是团队管理员，则可以使用团队徽标自定义已发布的文档。要添加徽标，请在团队设置中编辑您的团队资料。您的团队徽标将替换您团队已发布文档中的 Postman 徽标。（新徽标可能需要几分钟才能出现。）

共享您的公共文档

要共享您的公共文档，只需与您的团队成员、其他用户或社区共享已发布的 URL。如果您忘记了已发布文档的 URL，您可以随时获取：

1. 在左侧边栏中选择集合。
2. 选择包含已发布文档的集合旁边的三个点，然后选择查看文档。
3. 选择右上角的已发布，然后选择复制已发布链接。

如果您的收藏位于公共工作区中，其他人可以在Public API Network上搜索并找到您的收藏及其文档。如果您尚未将收藏移至公共工作区，您可以随时通过更改发布设置来执行此操作。

通过与公共 API 网络共享您的文档，您可以提高您的 API 对 Postman 社区中更广泛的消费者的可见性。了解有关公共工作区的更多信息。

更改发布设置

更改文档的发布设置以添加版本、更新文档的外观或公开您的收藏。您可以在发布文档后随时更改发布设置：

1. 在左侧边栏中选择集合。

2. 选择包含已发布文档的集合旁边的三个点，然后选择查看文档。

3. 选择右上角的已发布，然后选择编辑已发布的文档。

   

4. 选择编辑设置，然后根据需要更改发布设置。

5. 选择保存并重新发布。

取消发布您的文档

如果您不想再公开您的文档，您可以取消发布它：

1. 在左侧边栏中选择集合。
2. 选择包含已发布文档的集合旁边的三个点，然后选择查看文档。
3. 选择右上角的已发布，然后选择编辑已发布的文档。
4. 选择取消发布。

如果您改变主意，您可以随时再次发布您的文档。

下一步

了解有关查看文档的更多信息。