Mortal's Blog

生命不息,折腾不止!

使用postman工具测试接口和http请求

文章最后修改于:2020-9-28 14:01:11

1. Postman简介

1.1 Postman是什么

Postman是一个测试接口和http请求的开源工具,功能十分强大,它的优点如下:

  • 支持各种的请求类型: get、post、put、patch、delete 等
  • 支持在线存储数据,通过账号就可以进行迁移数据
  • 很方便的支持请求 header 和请求参数的设置
  • 支持不同的认证机制,包括 Basic Auth,Digest Auth,OAuth 1.0,OAuth 2.0 等
  • 响应数据是自动按照语法格式高亮的,包括 HTML,JSON 和 XML

Postman汉化版的工作界面如下:

《使用postman工具测试接口和http请求》

1.2 安装Postman

Github项目地址:https://github.com/postmanlabs

官网:https://www.postman.com/

Postman 可以单独作为一个应用安装,也可以作为 Chrome 的一个插件安装,建议选择前者。

如果你英文不好,可选择汉化版下载:https://github.com/hlmd/Postman-cn/releases

  • 方式1:Postman-..*-win64-.zip 解压直接用
  • 方式2:app.zip 解压&&替换文件 应用程序目录/resources/app.asar(注意:请替换相同版本的文件)

2. 基础知识储备

2.1 Web API简介及示例接口

  • Web API是网站的一部分,用于与使用非常具体的URL请求特定信息的程序交互,这种请求称为API调用。请求的数据将以易于处理的格式(如JSON或CSV)返回,依赖于外部数据源的大多数应用程序都依赖于API调用。

  • 以下我们使用Github的API作为示例进行测试:https://api.github.com/search/repositories?q=language:python&sort=stars

    注:很多API都要求你注册获得API密钥后才能执行API调用。目前GitHub没有这样的要求,但获得API密钥后,配额将高得多。

2.2 Get与Post的区别

GET与POST是我们常用的两种HTTP Method,二者最直观的区别就是GET把参数包含在URL中,POST通过request body传递参数。简单粗暴的理解就是GET是明文传递数据,POST是加密传递数据。所以后者比前者安全,通常用户名密码使用POST传递。

2.3 常见网络状态码及含义

常见网络状态码及其含义的详细说明:

  • 1×× : 请求处理中,请求已被接受,正在处理
  • 2×× : 请求成功,请求被成功处理(200 OK)
  • 3×× : 重定向,要完成请求必须进行进一步处理(301: 永久性转移、302:暂时性转移、304:已缓存)
  • 4×× : 客户端错误,请求不合法(400:请求有语法问题、403:拒绝请求、404:客户端所访问的页面不存在)
  • 5×× : 服务器端错误,服务器不能处理合法请求(500:服务器内部错误、503:服务不可用)

3. Postman基本使用流程

3.1 新建接口并设置请求方法

[1] 新建——请求 or 直接点工作区上面Tab页的“+”

[2] 在下拉框选择 HTTP 的 Method 方法并在Text框输入 API 的地址

[3] 在“头”处设置相关请求头信息

[4] 在“主体”处设置相关GET或POST等的参数

[5] 填写好之后,点击 Send 去发送请求 Request

[6] 请求成功之后,底部便可查看Response响应的信息

《使用postman工具测试接口和http请求》

3.2 生成API文档

在服务端后台的开发人员测试好了接口后,打算把接口的各种信息发给使用此 API 的前端的移动端人员时,往往会遇到:

  • 要么是用复制粘贴 -> 格式不友好
  • 要么是用 Postman 中截图 -> 方便看,但是不方便获得 API 接口和字段等文字内容
  • 要么是用 Postman 中导出为 JSON -> json 文件中信息太繁杂,不利于找到所需要的信息
  • 要么是用文档,比如去编写 Markdown 文档 -> 但后续 API 的变更需要实时同步修改文档,也会很麻烦

这都会导致别人查看和使用 API 时很不方便,对此Postman 提供了API,下面介绍 Postman 中如何预览和发布 API 文档。

待整个接口都调试完毕后,点击 Save 去保存当前 API 接口,然后需要填写相关的接口信息。

  • Request Name: 请求的名字

    一般保存为接口的最后字段名,比如 http://{% raw %}{{% endraw %}{server_address}}/ucows/login/login中的 /login/login

  • Request Description: 接口的描述

    最好写上该接口的要实现的基本功能和相关注意事项,支持 Markdown 语法

  • Select a collection or folder to save: 选择要保存到哪个文件夹

    往往保存到某个 API 接口到所属的该项目名的集合

注:直接点击Save去保存,只能保存API本身的Request请求,不会保存Response的数据。如果想要保存Response数据,可以通过Example这个功能去实现此效果。

4. 参考资料

[1] Postman 接口测试神器 from Gitbook

[2] api_tool_postman form Github

[3] Postman汉化版 from GitHub

[4] Postman记录您的API from Postman学习中心

[5] 快速掌握Postman实现接口测试 from 知乎

[6] 常见网络错误 from CSDN

点赞

发表评论

电子邮件地址不会被公开。

EA PLAYER &

历史记录 [ 注意:部分数据仅限于当前浏览器 ]清空

      00:00/00:00