Postman接口测试（九）：API 文档生成

原文链接
参考链接

API 文档生成

在服务端后台的开发人员测试好了接口后，打算把接口的各种信息发给使用此 API 的前端的移动端人员时，往往会遇到：

要么是用复制粘贴 -> 格式不友好 要么是用 Postman 中截图 -> 方便看，但是不方便获得 API 接口和字段等文字内容 要么是用 Postman 中导出为 JSON -> json 文件中信息太繁杂，不利于找到所需要的信息 要么是用文档，比如去编写 Markdown 文档 -> 但后续 API 的变更需要实时同步修改文档，也会很麻烦 这都会导致别人查看和使用 API 时很不方便。

-> 对此，Postman 提供了发布 API

预览和发布 API 文档 下面介绍 Postman 中如何预览和发布 API 文档。

简要概述步骤

1. Collection
2. 鼠标移动到某个 Collection，点击 三个点
3. Publish Docs
4. Publish
5. 得到 Public URL
6. 别人打开这个 Public URL，即可查看 API 文档

预览 API 文档

点击分组右边的大于号>

如果只是预览，比如后台开发员自己查看 API 文档的话，可以选择：View in web

等价于点击Publish Docs去发布：

View in Web 后，有 Publish 的选项（见后面的截图）

View in Web 后，会打开预览页面：

比如：

奶牛云

https://documenter.getpostman.com/collection/view/669382-42273840-6237-dbae-5455-26b16f45e2b9

而右边的示例代码，也可以从默认的 cURL 换成其他的：

发布 API 文档

如果想要让其他人能看到这个文档，则点击 Publish：

然后会打开类似于这样的地址：

Postman Documenter

https://documenter.getpostman.com/collection/publish?meta=Y29sbGVjdGlvbl9pZD00MjI3Mzg0MC02MjM3LWRiYWUtNTQ1NS0yNmIxNmY0NWUyYjkmb3duZXI9NjY5MzgyJmNvbGxlY3Rpb25fbmFtZT0lRTUlQTUlQjYlRTclODklOUIlRTQlQkElOTE=

点击 Publish 后，可以生成对应的公开的网页地址：

打开 API 接口文档地址：

https://documenter.getpostman.com/view/669382/collection/77fd4RM

即可看到（和前面预览一样效果的 API 文档了）：

如此，别人即可查看对应的 API 接口文档。

已发布的 API 文档支持自动更新

后续如果自己的 API 接口修改后：

比如：

（后来发现，不用再去进入此预览和发布的流程，去更新文档，而是 Postman 自动支持）

别人去刷新该文档的页面：

https://documenter.getpostman.com/view/669382/collection/77fd4RM

即可看到更新后的内容：