Postman 如何导出接口文档?

本文将介绍如何使用 Postman 工具来导出接口文档,让你的 API 接口文档分享更方便。

用 Apifox,节省研发团队的每一分钟

Postman 如何导出接口文档?

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

Postman 是一款广泛使用的 API 接口测试工具,除了测试接口,它还能够导出接口文档。在下文,我们将介绍如何使用 Postman 导出接口文档。想要学习更多关于 Postman 的知识,可访问 Postman 中文文档

 

步骤 1:在 Postman 中创建一个 Collection

Collection 是 Postman 中最基本的组织单元,用来存储一系列相关的请求。如果您已经有了一个 Collection,可以跳过这一步。

  1. 打开 Postman,点击左上角的“New”按钮,选择“Collection”。
  2. 输入 Collection 的名称和描述,然后点击“Create”按钮。
Postman 如何导出接口文档
创建 Collection

步骤 2:添加请求到 Collection

在 Collection 中添加请求,可以方便我们后续导出文档时对请求进行分类和分组。

  1. 在左侧的导航栏中选择您创建的 Collection。
  2. 点击右上角的“+”按钮,选择“Request”。
  3. 输入请求的名称和 URL,选择请求的方法和参数。
  4. 点击“Save”按钮。
Postman 如何导出接口文档
添加请求

步骤 3:添加请求的描述和注释

在导出接口文档时,请求的描述和注释能够提供更多的信息,方便其他人了解接口的功能和使用方法。

  1. 在请求列表中选择某一个请求。
  2. 在请求编辑界面的右侧,选择“Description”选项卡。
  3. 输入请求的描述和注释,点击“Save”按钮。
Postman 如何导出接口文档
添加描述和注释

步骤 4:导出项目

在完成 Collection 和请求的设置后,我们就可以导出项目了。

1、在左侧的导航栏中选择您创建的 Collection。

2、点击右上角的“...”按钮,选择“Export”。

Postman 如何导出接口文档
导出项目

3、目前 Postman 只支持导出 JSON 格式,真正的接口文档形式仍有很大的差距。

postman 导入 JSON 格式
Postman 导出

更高效的导出接口文档的方法

我们可以使用 Apifox 来更高效的导出接口文档,Apifox 不仅可以在 API 设计后一键生成文档,还支持导出多种格式的文档,比如 Swagger、Markdown等,同时允许在线分享文档供外部团队查看。

 

API 设计后一键生成接口文档

1、Apifox 支持可视化 API 文档设计功能,无需手写 Markdown 或 YAML,零学习成本,高效便捷。

2、遵循 OpenAPI(Swagger) 规范

3、接口文档完全遵循 OpenAPI(Swagger) 规范,支持 JSON Schema。

支持多数据源导入,自动生成 API 文档

支持导入 Swagger(OpenAPI), Postman, Jmeter, apiDoc, RAP2, YApi 等等数据格式,一键生成接口文档。

Postman 如何导出接口文档
导入接口文档

 

支持多数据源导出

Apifox 支持导出 OpenAPI(Swagger)、HTML、Markdown、Apifox 格式,无需二次转换格式,文档生成更轻松。

Postman 如何导出接口文档

在线文档分享

1、一键发布&分享

设计完(或导入) 的API 文档,一键分享给合作伙伴,接口变更实时同步,支持公开或加密发布。。

2、API 文档支持“在线调试”

API 文档页面支持“调试”功能,可以在线请求真实接口并返回数据。

3、自定义导航、自定义样式

API 文档可自定义导航和页面样式,可以将 API 文档的导航条做成跟官网一致。

4、个性化域名、自定义域名

支持自定义的 Apifox 文档域名,也可绑定到自有的域名。

Apifox 在线文档分享
Apifox

比 Postman 更好用的工具: Apifox

Apifox 是一体化 API 协作平台,可以实现 API 文档、API 调试、API Mock、 API 自动化测试,是更先进的 API 设计/开发/测试工具。Apifox 提供了一种全面的 API 管理解决方案。使用 Apifox ,你可以在一个统一的平台上设计、调试、测试以及协作你的 API,消除了在不同工具之间切换和数据不一致的问题。 简化了你的 API 工作流,并确保了前端、后端和测试人员之间的高效协作。

Apifox
Apifox

知识扩展: