发布文档（Publishing）

发布你的文档会使任何人都可以通过文档链接和 Web 浏览器访问它。发布你的文档以帮助世界各地的人们了解如何使用你的收藏或与你的公共 API 进行交互。

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

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

公开你的文档

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

你不能发布具有 gRPC 请求或 WebSocket 请求的集合。此外，你不能发布已添加到 API 的集合。相反，你可以发布 API 的一个版本。已发布版本包括 API 的定义和集合。

要发布集合的文档，请执行以下操作：

在边栏中选择收藏集。
选择集合旁边的更多操作图标，然后选择查看文档。
选择右上角的发布。
根据需要更改任何发布设置：
- 版本- 如果集合有多个版本，请选择要发布的版本。（你不能再在 Postman v10 中为集合创建版本或发布，但你可以发布 API 的版本。）
- 环境- 选择一个环境以随你的文档发布环境变量。所有变量的初始值都与你的文档一起发布，因此请确保它们不包含敏感信息，例如密码或令牌。
- 自定义域- 选择要发布文档的自定义域。
- 默认布局- 选择文档的布局样式。双列在文档旁边的一列中显示示例代码。单列显示每个请求下方的内联示例代码。
- 默认主题- 为你的文档选择浅色或深色主题。你也可以选择使用系统主题。默认情况下，你的文档将使用选定的主题，但用户可以在主题之间切换。
- 徽标- 默认情况下，公共文档使用你的团队徽标。你还可以为每个主题（浅色和深色）选择自定义徽标：
  你可以为你发布的每个集合使用不同的徽标。徽标的大小不得超过 2 MB，并且必须为 JPEG 或 PNG 格式。徽标可以是任何纵横比（方形或矩形）。
- 颜色- 你可以为每个主题自定义颜色（浅色和深色）：
  - 标题背景- 为文档窗口顶部的标题指定颜色（十六进制格式）。
  - 代码背景- 为示例代码块指定颜色（十六进制格式）。
  - 突出显示- 指定超链接的颜色（十六进制格式）。
- SEO - 你可以将元数据添加到文档中，使其在网络上更容易被发现：
  - 标题- 为你的文档添加标题（60 个字符或更少）。标题将出现在网络搜索和浏览器选项卡中。
  - 说明- 添加简短说明，让用户了解你的文档的内容（不超过 160 个字符）。你还可以添加相关关键字，以帮助用户在网络搜索时找到你的文档。
要使用当前设置预览你的文档，请选择预览文档。当你更改设置时，预览会自动更新。
如果 Postman 检测到可能敏感的令牌或其他机密，则会在预览窗口的顶部显示一条警告。Postman 还会突出显示令牌，以便你可以在发布前将其从文档中删除。
完成更改设置后，发布你的文档：
- Postman Free、Basic 和 Professional 计划- 你可以选择一个公共工作空间来将集合移动到其中。这将使集合在公共 API 网络上可被发现。准备就绪后，选择发布。你可以在提供的 URL 上查看你的公共文档。
- Postman Enterprise 计划- 你的社区管理员控制你的团队公开的 Postman 元素。为你的社区管理员输入注释并选择Request Publish。当你的请求获得批准后，你将收到一封电子邮件通知，其中包含指向公共文档的链接。要撤回你的发布请求，请更改待定发布设置并选择撤回请求。