postman接口测试工具生成接口文档

最新推荐文章于 2024-09-21 18:15:00 发布
最新推荐文章于 2024-09-21 18:15:00 发布
阅读量1.5k 收藏
点赞数
分类专栏： 测试
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42531204/article/details/109067176
版权

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

简要概述步骤
Collection
鼠标移动到某个Collection，点击 三个点
Publish Docs
Publish
得到Public URL
别人打开这个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

即可看到更新后的内容：
在这里插入图片描述
出处： https://crifan.github.io/api_tool_postman/website/postman_api_doc/preview_publish_api_doc.html

有理想的小偷
关注
专栏目录
postman接口测试工具详解
数字人生
07-24 1194
Postman 是一款非常流行的API开发和测试工具，广泛用于API的构建、测试、修改和调试。综上所述，Postman凭借其强大的功能、用户友好的界面以及广泛的集成能力，成为了API开发和测试领域的重要工具。Postman是一款广泛使用的API开发工具和接口测试工具，具有强大的功能和用户友好的界面，适用于开发、测试和文档编写等多种场景。：对于POST等方法，可以设置请求体，支持form-data、x-www-form-urlencoded、raw（文本、JSON、XML等）和binary（文件上传）。
1.10 实战：Postman生成在线接口文档
zyg的博客
12-11 1357
实战：Postman生成在线接口文档
最强PostMan使用教程（5）- 工作协同：使用Postman生成接口文档和示例
热门推荐
点火三周的专栏
08-27 6万+
Postman这个Documentation功能对于前后端分离的团队，接口开发团队来说真的是提升沟通效率和工作效率的一个利器。废话不多说，直接上干货来看如何通过Postman来生成接口文档和发布接口文档，以及如何定制化文档中的内容。 流程概要 定义一套接口，为接口生成文档和示例一般来说有以下步骤：（这里只列出postman参与的部分） 创建一个接口集合，描述该接口集合的功能、范围等信息 将...
Postman如何导出接口的几种方法
weixin_71807218的博客
07-09 3921
本文主要介绍了Postman如何导出接口的几种方法，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下前言：我的文章还是一贯的作风，简确用风格（简单确实有用），你们可叫我职场新人救星！好的废话不多说，今天这篇文章讲的是如何用postman导出！解决怎么把自己用postman测试的用例分享给同事，让同事直接导入到自己的postman里，快速了解熟悉项目。正文：一、新建接口文件夹。
接口测试工具和接口文档生成
Gina61的博客
10-23 135
最近在研究接口测试，然后在网上找工具来进行接口测试。现在主流使用的接口测试工具一般有：jmeter、postman、soapui、apipost jmeter可以进行接口测试和性能测试，但是对于做单纯的接口测试jmeter操作起来没有postman、apipost使用起来方便。jmeter重点在于压力测试，稳定性测试和负载测试。针对于接口和程序的稳定性设计的一块以软件性能为主接口测试为辅的接口测试工具。 postman是Google开发的一款接口测试的插件，也有客户端。国内禁用Google之后，post
Postman写接口文档
小男孩tom的博客
06-30 1万+
Postman 接口文档，团队协作开发
docodile：从Postman集合生成HTML API文档
02-04
十二指肠 从Postman集合生成HTML API文档 目前的代码很糟糕 用法 别忘了先运行composer install ./docodile generate /path/to/postman/collection.json /my/output/directory 如果/my/output/directory已经存在，则该过程将退出，因为继续将完全删除该目录。 --force将强制删除 --url：为url添加选项。 例如“ ” 主题化 Docodile现在支持从bootswatch（ ）和Highlightjs捆绑样式（ ）切换主题 例如： ./docodile gener
Postman接口测试工具
02-04
Postman是一款功能强大的接口测试工具，它被广泛用于前端和后端开发人员、测试工程师以及API开发者之间，以确保服务和应用程序之间的数据交互顺畅无阻。接口测试是软件开发过程中的重要环节，它验证不同系统组件间的...
Postman接口测试工具chrome插件
04-27
Postman是一款广受欢迎的接口测试工具，尤其在Web开发者和测试人员中被广泛使用。它最初作为一款Chrome浏览器插件而流行，随着时间的发展，现在已发展成为独立的应用程序，但仍然支持Chrome插件形式。Postman能够...
Postman接口测试工具实战演练集
萌笑天的博客
12-20 1万+
主要进行工具下载安装以及工具日常测试使用的内容进行讲解，并收录整合成一个合集
小技巧——postman生成在线文档
qq_43201350的博客
08-06 1424
小技巧——postman生成小技巧——postman生成在线文档在线文档
docman:Postman REST Client的文档生成器
05-20
Docman 文档生成器。 Docman解析Postman转储文件，并将文档输出为Markdown文件集。 特征 按集合组织文档 参数化的URL 查询参数 主体（表单/未定居/ RAW / JSON字符串有效负载）参数 回应范例 安装 全局安装Docman： npm install -g docman 用法 Docman有两个参数： dump ： Postman JSON转储文件的文件路径（在Postman设置->数据->导出数据中） dir ： Docman应该在其中生成文档的输出目录。 如果提供的目录不可写，Docman将尝试将文档生成到./docs 句法： docman <dump> <dir> 例子： docman ./Backup.postman_dump /Users/me/myapp/api_docs 开发Docman Docman捆绑了Dockerf
postman自动生成接口文档
一个努力不被优化的程序员
07-01 2049
postman自动生成接口文档
Postman工作协同：生成接口文档和示例，超实用
2301_78276982的博客
01-19 1916
这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！
Postman：Postman高级功能：API文档自动生成与发布
最新发布
kkchenjj的博客
09-21 584
在Postman中，你可以通过自定义API文档的样式来提升其可读性和专业性。这不仅包括了字体、颜色和布局的调整，还可以嵌入品牌元素，如logo和主题色，以确保文档与你的品牌形象一致。创建或编辑API：首先，确保你有一个API在Postman中，无论是从头开始创建还是编辑现有的API。访问文档设置：在API的文档视图中，点击右上角的齿轮图标，选择“编辑”以进入文档设置。自定义样式：在文档设置中，你可以找到“样式”选项，这里允许你上传logo，选择主题色，以及调整字体和布局。
Postman如何生成接口文档
斧头湖懒客
08-04 1万+
接口测试工具，更适合国人的使用习惯，一键生成接口文档，一键导出，不用有postman的麻烦操作。仅供参考。
Postman接口测试工具全面指南
"这篇文档是关于接口测试工具Postman的使用教程，涵盖了Postman的基本功能，包括环境变量的设置、批量执行测试用例、结果校验、导入导出、以及如何读取本地文件作为参数。" Postman是业界广泛使用的接口测试工具，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值