postman API自动写文档与测试高级教程

在写API时,会对测试的数据与环境有要求,比如一些API他是需要授权 access_token 才能访问的, 而这个 access_token 是一个授权API获取的,而这个API又需要不同的账号登陆来获取不同权限的数据来做复杂的测试环境,这个postman就是首选。 我们就以 Flask个人博客项目实战-API接口模块 这个模块的开发的前期与后期维护做为例子 现在我们来模拟下场景,就是这个API接口在开发的前期,我们也可以用这个 postman 来做API规划, 这样会让我们在做开发时做到思路清晰: 现在我们看下我们的项目结构分析下有几个模块,并且可提供哪些功能API

用户模块
- get 获取用户信息(这里是根据用户授权得到的access_token去获取用户信息)
- post 用户授权 access_token(jwt)
- post 用户修改(这里暂时提供修改昵称与密码)
文章模块
- get 文章列表(可获取所有文章,或者是指定的栏目文章)
- get 文章详情获取指定ID的文章详情,并同布获取对应的栏目信息)
- post 文章添加(这里需要用户授权access_token才能添加)

当分析出需要的API的逻辑后,我们就用上我们的 postman 来做管理

第一步 创建项目目录

https://lsol-house-upload.oss-cn-hangzhou.aliyuncs.com/2019-12-03/4fa7c4ae-57d0-4979-bf2d-390b6fb32b7a.png

在variables处增加一个如图 url=http://127.0.0.1:5000 这里的需求就是当你的项目url地址会变时, 而API接口比方说有100个,那100个API都去改那个请求URL肯定就笨死了,所以用项目的全局变量来引用, 到时看下面的介绍就会知道用处

现在在这个项目控制中先添加两个目录

用户模块
文章模块

并给两个模块先添加我们上面分析的几个接口可以是空,但是都建起来。这样我们就知道我们接下来需要做什么接口,如图:

https://lsol-house-upload.oss-cn-hangzhou.aliyuncs.com/2019-12-03/7530acaa-cf45-4a57-b79b-1227a72889dd.png

接下来争对 postman 的这里的API我们去程序那建相应的API。为什么这样,因为当API很多的情况下, 我们是记不住的,只要争对这里的API去做设计与调试,就相当于有笔记了。

下一歩是开发期