Postman官方下载文档快速创建图文教学

Postman是一款API 开发协作平台，简化构建 API 的每个步骤并简化协作，以便您可以更快地创建更好的 API。

快速创建自定义 API 文档

Postman 允许您快速轻松地发布文档。Postman 会自动提取您的示例请求、标头、代码片段等，以使用动态示例和机器可读指令填充您的文档页面，以便您可以轻松地与世界其他地方共享您的 API。

您可以为 Postman API 自动生成文档。您可以私下共享您的文档或将其发布到网络上。Postman 基于集合生成和托管文档，实时同步并可通过浏览器访问。您可以使用文档与团队成员和合作伙伴协作，或支持开发人员采用您的公共 API。

Postman官方下载文档快速创建图文教学图1

记录现有集合

要从 Postman 生成和查看现有集合的文档，请使用左侧的“集合”选项卡选择集合。选择您需要记录的集合并打开集合详细信息。在右侧，您可以从文档选项卡创建文档。

Postman官方下载文档快速创建图文教学图2

或者，您可以选择查看完整的馆藏文档，以在展开的视图中创建和编辑您的文档。或者，使用“新建”按钮，然后选择“ API 文档”。选择Select an existing collection并单击要查看其文档的集合。输入或编辑您的收藏的降价说明，然后点击保存。

Postman官方下载文档快速创建图文教学图3

您将看到您的文档已发布的确认信息，以及您可以访问以在浏览器中查看它的链接。您可以直接在文档页面上进行其他编辑——您会在悬停时看到可编辑区域突出显示。单击以进行编辑、更改并保存它们以更新文本。

Postman官方下载文档快速创建图文教学图4

您还可以从Web 仪表板查看文档 -选择查看所有集合，然后选择一个集合以在浏览器中查看其文档。默认情况下，您的文档是私有的，因此只有与您共享该集合的人才能看到它。您可以发布文档以供公众查看。

默认情况下，您的文档中包含一些详细信息，您可以选择添加更多详细信息。

为新集合创建文档

您可以从 Postman 启动屏幕或使用New按钮并选择API Documentation 创建文档。默认情况下将选择创建新集合。添加您想要在新集合中记录的任何初始请求，然后单击下一步。

Postman官方下载文档快速创建图文教学图5

为集合命名，输入要在您的文档中显示的降价说明，然后点击保存。您将看到您的文档已发布的确认信息，以及您可以访问以在浏览器中查看它的链接。

Postman官方下载文档快速创建图文教学图6