今天在开发项目时,需要使用postman
来调试部分接口,那么,便利用这个时间来解说postman
这款优秀的接口调试工具。他不仅可以调试不同请求方式的接口,还能更友好地管理我们的接口。
接下来我便从postman
的安装方式、接口管理,请求方式等介绍如何使用postman
。
postman
不仅适用于不同的操作系统(mac
、Windows
、Linux
系统),还支持postman
浏览器扩展程序、postman chrome
应用程序等。
postman
官网地址如下。https://www.postman.com
因为我是Windows
系统,所以选择Windows
下载方式。
如果你使用Chrome浏览器
下载的,它会提醒你这种类型的文件可能会损害您的计算机,没关系,单击保留即可。
下载完成后,单击如下Postman-win64-Setup.exe
即可,或者单击在目录中显示
后在单击Postman-win64-Setup.exe
。
因为postman
是免安装的,单击Postman-win64-Setup.exe
即可完成安装,如下所示。
如果你此前没有注册过postman
,可以单击右上角橘色的Create Account
按钮,它会跳转到postman
的网页注册页面,如下所示:
单击右上角灰色的Sign in
按钮,它会跳转到postman
网页端登录页面,如下所示:
此电脑
卸载或更改程序
输入postman
单击灰色面板,出现卸载
二字,单击即可。
还记得上述注册和登录postman
吗?因为在登录postman
前提下,创建需要调试的接口后,即便我们电脑出现故障而需要重装,当我们再次登录,之前的接口还会完好无缺地出现。
我们在公司往往需要做几个项目,每个项目下又有不同的模块,不同的模块又有多个接口。
为了更合理清晰地管理这些接口,我们需要创建项目目录,在项目目录下创建模块目录,在模块目录下创建对应的接口。
如下以滴答旅行这个项目为例,来清晰地管理我们的接口。滴答旅行包含用户模块,用户模块包含登录、注册、详情、删除等接口。
我们可以进行如下创建接口。
找到左上角的Collection
,点击+
按钮,如下图所示:
单击+
号完成后,会出现一个名为New Collection
的目录。
New Collection
的目录为滴答旅行
,如下图所示:滴答旅行
目录下创建用户模块
的目录,如下所示此时,会出现一个New Folder
目录,我们安装如下修改New Folder
目录即可。
用户模块
的目录下创建登录
接口此时你会看到一个New Request
名字,根据如下方式将New Request
修改为登录
。
用户模块
如此创建。这样是不是把我们的接口管理的很清晰。
在街口面板中,我们能看到请求方式,请求参数、响应内容等信息。
我启动spring boot
服务,并调用部分接口,来讲解如下的请求方式。
get
请求点击Params
,输入参数及value
,可输入多个,即时显示在URL链接上。
GET
请求的请求头与请求参数如在接口文档中无特别声明时,可以不填。
如下以获取用户详情为例子,来说明get请求
。
必须换成xml
查看,如下图所示:
username = 念兮为美
的参数token
回去用户信息我们在实际开发时,在调用登录接口时获取返回的token。我们拿着token去获取用户详情,如下图所示:
当然,我们也可以这样使用token
:
post
请求方式post
提交的数据会放在请求体中,我们在接口后面是看不到请求数据。
其会有两次响应,第一次是status = 100
,表示数据已提交,第二次是status =200
,表示响应成功。
我们可以使用以下几种方式,提交post请求。
json
提交form-data
提交XML
提交其它请求方式如PUT,DELETE 大致流程和GET,POST 差不多,这里就不一一举例说明了
身份验证Authentication,比如Bearer Token
,No Auth
等,如下图所示:
这是基础的验证,其会直接把用户名、密码的信息放在请求的Header
中。
比如上述获取用户详情时,把Bearer token
放在header
中,如下图所示:
比Basic Auth
复杂的多,使用当前填写的值生成authorization header
。
所以在生成header
之前要确保设置的正确性。
如果当前的header
已经存在,postman
会移除之前的header
。
3、OAuth 1.0
postman
的OAuth helper
让你签署支持OAuth
。
1.0基于身份验证的请求。OAuth
不用获取access token
,你需要去API
提供者获取的。
OAuth 1.0
可以在header
或者查询参数中设置value
。
4、OAuth 2.0
postman
支持获得OAuth 2.0
, token
并添加到requests
中。
其他的认证方式,可以自己去尝试看看。
如果读者发现文章有错误的地方,欢迎指正。
postman
功能很强大,以上列出的信息可能不全,读者可以自行去尝试,在尝试中获得成长。