Postman接口测试工具中如何预览和发布API文档

发布时间: 编辑:CINDY 0人评论 506次浏览 实用方法教程
摘要 : 本文详细介绍Postman接口测试工具中如何预览和发布API文档。
下面介绍Postman中如何预览和发布API文档。

简要概述步骤

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

详细解释具体操作

预览API文档

点击分组右边的大于号>

Postman接口测试工具中如何预览和发布API文档

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

Postman接口测试工具中如何预览和发布API文档

等价于点击Publish Docs去发布:

Postman接口测试工具中如何预览和发布API文档

View in Web后,有 Publish的选项(见后面的截图)

View in Web后,会打开预览页面:

比如:

奶牛云

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

Postman接口测试工具中如何预览和发布API文档

Postman接口测试工具中如何预览和发布API文档

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

Postman接口测试工具中如何预览和发布API文档

Postman接口测试工具中如何预览和发布API文档

发布API文档

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

Postman接口测试工具中如何预览和发布API文档

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

Postman Documenter

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

Postman接口测试工具中如何预览和发布API文档

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

Postman接口测试工具中如何预览和发布API文档

打开API接口文档地址:

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

即可看到(和前面预览一样效果的API文档了):

Postman接口测试工具中如何预览和发布API文档

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

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

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

比如:

Postman接口测试工具中如何预览和发布API文档

Postman接口测试工具中如何预览和发布API文档

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

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

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

即可看到更新后的内容:

Postman接口测试工具中如何预览和发布API文档

文章转自: https://crifan.github.io/api_tool_postman/website/postman_api_doc/preview_publish_api_doc.html


查看更多

转载必须注明来自:https://huajiakeji.com/utilities/2020-11/4080.html

PostWoman Http接口调试插件

PostWoman Http接口调试插件

0 人评论 1495 次人浏览 4.0分 4.0 分
Postwoman(原apiDebug) 是一个完全免费的接口调试插件,该插件可独立使用,同时数据也能同步至云端,实现跨终端共享。Postwoman支持post、get、xml、josn等测试,支持环境切换(全局变量)。
ApiPost中文接口测试软件

ApiPost中文接口测试软件

0 人评论 844 次人浏览 4.0分 4.0 分
ApiPost是中国人自己的接口测试软件,是一个支持团队协作,并可直接生成文档的API调试、管理工具,支持模拟POST、GET、PUT等常见请求,是后台接口开发者或前端、接口测试人员不可多得的工具。
ApiPOST - API调试管理工具

ApiPOST - API调试管理工具

0 人评论 21677 次人浏览 4.0分 4.0 分
ApiPOST是一款可直接生成文档的API调试、管理工具。2.0版本大更新,支持自定义请求头(Request Header)、查看Cookie、导出Html及Word文档等更多功能。
Postman的基础使用方法教程介绍

Postman的基础使用方法教程介绍

0 人评论 458 次人浏览 3.0分 3.0 分
Postman是一款功能强大的网页调试与发送网页HTTP请求的工具。用于API测试的工具。在我们平时开发中,特别是需要与接口打交道时,无论是写接口还是用接口,拿到接口后肯定都得提前测试一下。我们可以用来很方便的模拟get或者post或者其他方式的请求来调试接口。在Postman中,请求可以保存,也就类似于文件。
评论:(0)

已有 0 位网友发表了一针见血的评论,你还等什么?