postman怎么自动获取token 如何写好API接口文档?

[更新]
·
·
分类:互联网
1921 阅读

postman怎么自动获取token

postman怎么自动获取token 如何写好API接口文档?

如何写好API接口文档?

如何写好API接口文档?

开发人员有时会花数周时间构建API,可能还要花一周时间编写文档,这非常耗时。问题是,20分钟内生成API文档可能吗?是的,这是可能的。我们现在将学习如何做这件事。

显然,Postman是测试API端点最常用的REST客户端,但大多数人不这么做。;我没有意识到它可以用来生成格式良好的文档。在本教程中,我们将展示一个简单的技术,展示如何使用Postman来减轻生成文档的压力。

在本教程中,我赢了 t介绍如何构建API,假设您已经有一个现有的API接口和相应的端口和参数内容。

使用您现有的请求生成文档。如果您已经在Postman上测试了该接口,那么恭喜您,现在您所要做的就是返回到请求,并将它们添加到集合中。

什么是POSTMAN Collection POSTMAN Collection使您能够随时以可重用和共享的保存请求。它还允许您对请求进行分组,以便每个API资源可以像保存文件夹一样保存类似的接口请求。让 向集合中添加一个现有的请求。

如何将现有请求添加到集合中。

在现有的请求窗口中,按住Command的键,单击Create Favorite,添加您的首选名称,然后单击Save按钮。完成以上步骤后,您现在有了一个集合,您可以进一步添加您的请求。现在创建一个新收藏,它将出现在“收藏”选项卡上。

之后,您需要做的就是向集合中添加新的或现有的请求。邮递员如何为你实现自动化?

页眉(帮助您将所有页眉添加到文档中)。请求正文(发送到端点的JSON请求已被复制到您的文档中。您的请求及其HTTP动词(POST、GET、PUT、PATCH等。)会自动为您添加。你必须自己做什么?您可以自己对接口请求进行注释,然后转到收藏夹和任何您想要添加描述的请求。

单击编辑选项为请求添加描述。当您单击编辑链接时,将打开一个新的弹出模式,您可以添加描述。

添加描述后,单击保存按钮。接下来要做的是转到收藏夹中的任何请求,并为其添加描述。剩下的工作就是在Postman服务器上发布你的文档。现在转到您的收藏,然后转到选项菜单。

如果您在生成的文档中发现任何错别字,您总是可以返回到集合并编辑它,但是不要 不要忘记再次发布文档。然后会自动生成一个简单的API接口文档~