Postman接口测试01|接口测试基础概念、http协议、RESTful风格、接口文档

devtools/2025/1/12 15:47:56/

目录

一、接口测试基础概念

1、什么是接口

2、接口的类型

3、什么是接口测试

4、为什么要做接口测试

5、接口测试的实现方式

6、什么是自动化接口测试？

二、接口返回的数据格式

1、三种格式

2、Json

三、接口协议

1、webservice协议

2、dubbo协议

http%E5%8D%8F%E8%AE%AE%E5%92%8Chttps%E5%8D%8F%E8%AE%AE-toc" style="margin-left:80px;">3、*http协议和https协议（重要）

1️⃣基础概念

http%E5%8D%8F%E8%AE%AE-toc" style="margin-left:120px;">2️⃣什么是http协议

3️⃣URL格式 

4️⃣http请求

5️⃣http响应

四、传统风格和RESTful风格接口

1、传统风格接口

2、RESTful风格接口

五、接口测试的流程

1、接口文档

1️⃣什么是接口文档

2️⃣作用

3️⃣展现形式

4️⃣结构

2、接口文档解析

1️⃣登录接口为例

2️⃣员工修改接口为例 

一、接口测试基础概念

1、什么是接口

电脑：USB、投影仪（为了数据传输）

软件：统称API（application program interface）、微信提现和充值、支付宝支付（调用需要用到鉴权码：token、key、appkey）

接口包括：

  • 内部接口：开发人员自己开发的对自身系统提供的接口
  • 外部接口：开发系统调用外部的，微信，支付宝等

总结：接口是指一组预定义的函数、方法或协议，是数据交互的通道，允许不同的软件应用程序之间进行交互、数据交换和功能调用。它是软件组件之间的中介，定义了如何通过标准化的方式进行访问、调用和操作某个功能或服务。API接口通常由函数、类、数据结构等组成，并且通过一定的规则或协议提供服务。

2、接口的类型

按划分形式，大致分为3类

①按协议分。协议不同，接口类型不同。HTTP、TCP、UDP、IP、FTP、USB …..

②按语言划分。Java、Python、C++、Php ....

③按范围划分。系统之间和程序内部。

  • 系统之间：内部系统之间，内部系统和外部系统之间。
  • 系统内部：方法（函数）和方法（函数）之间。类和类之间。模块和模块之间。

https://i-blog.csdnimg.cn/direct/c7a303e304f443a78c3798264c2e6530.png" width="308" />

3、什么是接口测试

测试系统或组件之间交互的数据的正确性，以及逻辑依赖关系的正确性！

做接口测试需要不借助前端页面或后端代码，就能组织数据并模拟客户端做接口测试，检查响应数据是否符合预期。

分类:
测试外部接口:是被测系统和外部系统之间的接口。(一般只要正常调用即可)
测试内部接口:是被测系统内部各个模块之间的接口。
                     ①内部接口提供给内部系统使用(一般只要正常调用即可)
                     ②内部接口提供给外部系统使用(测试必须非常全面，考虑各种异常场景或权限控制)

4、为什么要做接口测试

  • 提早介入，符合测试的质量控制前移原则
  • 接口测试可以发现页面操作发现不了的问题。如：支付密码，输入非数字、特殊字符。
  • 低成本高收益（接口的一个bug ，可能对应上层界面 N 个bug）
  • 接口测试，不同于传统的单元测试，站在用户的角度展开测试。

总结：

接口的本质是一组函数、方法或协议。

接口测试的本质是测试接口是否能正常的交互数据，权限控制，以及异常场景。

5、接口测试的实现方式

①工具实现：Postman、fiddler、jmeter

②代码实现：Python + UnitTest + request

6、什么是自动化接口测试？

利用工具、代码 代替人工，自动判断响应结果和预期结果 是否一致。依赖断言！

二、接口返回的数据格式

1、三种格式

接口返回的数据格式一共有三种：

  • Json格式（80%都使用这个）：约定俗成返回三组数据 {error_code:0,msg:"提现成功",data:[]}，其中，

             error_code表示错误码，0代表成功；

             msg代表对错误码的中文说明；

             data表示真正的返回数据

  • Html格式：

              <html>

                     <title></title>

                     <body>

                              <error_code></error_code>

                               ……

                      </body>

             </html>

  • Xml格式：

              <?xml?version="1.0" encoding="utf-8">

                               <error_code></error_code>

                               ……

             </xml>

2、Json

Json就是一种数据类型。由两组数据组成，且两组数据格式可以相互嵌套

  • MAP对象：键值对，{key:value , key:value}
  • 数组：[value1,value2,value3,]
https://i-blog.csdnimg.cn/direct/3a5a8aea2f4d496c8887d2ea27f96c79.png" width="196" />
Json数据例子​​

在线校验Json结构等功能的网站：www.bejson.com

三、接口协议

协议：就是规则！要求使用协议的双方，必须严格遵守！

1、webservice协议

接口地址：http://...................?wsdl

restful规则：get获取数据，post提交数据，delete删除数据

https://i-blog.csdnimg.cn/direct/442bd83496f2449c9ba10148863daf5c.png" width="525" />
由于restful规则的出现，多个接口地址实现的功能可以由一个接口地址实现

2、dubbo协议

接口地址以dubbo://......开头

适用于少量数据的传输，大并发。

http%E5%8D%8F%E8%AE%AE%E5%92%8Chttps%E5%8D%8F%E8%AE%AE">3、*http协议和https协议（重要）

1️⃣基础概念

接口地址：http://..........开头或者https://..........开头

https=http+ssl安全传输协议

http%E5%8D%8F%E8%AE%AE">2️⃣什么是http协议

http是超文本传输协议，基于请求和响应模式的应用层协议。主要用于浏览器和服务器之间交互数据,交互有两个部分：
请求：get，post，put，delete
响应：1XX信息，2XX成功，3XX重定向(跳转不传值)，4XX客户端错误，5XX服务器错误。

3️⃣URL格式 
  • URL：（Uniform Resource Locator）统一资源定位符，是互联网上标准资源的地址。HTTP使用URL来建立连接 和 传输数据
  • URL作用：建立连接、发送数据。
  • 语法格式：

https://i-blog.csdnimg.cn/direct/d66cfe873eac46af94af1ec635f1d4da.png" width="548" />

①协议：http 和 https

②域名：本质 IP地址（定位网络环境中的一台主机）

③端口号：在网络主机上，定位一个应用。端口号可以省略。没有指定端口号，默认跟随协议

            ⚪ http 协议默认端口：80
            ⚪ https 协议默认端口：443

            （补充：MySql的默认端口是3306、redis的默认端口是6379） 

④资源路径：对应网页的源代码 或 网络中的一个数据资源（例如图片）

            ⚪ 资源路径可以为空（没有），相当于资源路径为 “/” 

https://i-blog.csdnimg.cn/direct/d78b3cb8731b4919979db27ee239f4ea.png" width="188" />

            ⚪ 如有查询参数，资源路径为 ？之前 域名(端口) 之后的所有内容！ 

https://i-blog.csdnimg.cn/direct/ba276db82c8c4cbd8259120e1baf1b5b.png" width="334" />

            ⚪ 如果没有查询参数，资源路径，从 域名(端口) 之后，直到结束。 

https://i-blog.csdnimg.cn/direct/5870905ceba54fbe8e20339a7e6d5ec8.png" width="722" />

⑤查询参数：传参给网页源代码。

            ⚪ 以 ？ 与 资源路径 隔分
            ⚪ 查询参数可以有多个，之间用 & 隔分。
            ⚪ 参数参数的语法 k=v 对儿

4️⃣http请求
  • 作用：由 客户端 发送给 服务器；规定了发送给服务器的数据的语法格式 
  • 完整语法格式：请求行、请求头、空行、请求体

https://i-blog.csdnimg.cn/direct/7aeac374dbbc4c8489396306496b205a.png" width="594" />

【补充】GET和DELETE请求不包含请求体，需要的参数或资源标识符通过URL指定；POST、PUT请求具有请求体，表示提交或更新的数据。

【补充】怎么查看http请求：任意网页→右键→“检查”→Network→在网页上执行需要的操作→一般出现的第一个就是http请求（→点击左上处🚫按钮即可清空目前请求）

 ①请求行：

  • 作用：指定请求方法、请求资源 
  • 语法格式： 包含了请求方法、URL、协议版本三部分

https://i-blog.csdnimg.cn/direct/0247f5a1e90d46cc951ac5e3b5f48bab.png" width="488" />

  • 请求方法：下面是常用的四种

            ⚪GET：查询。 —— 没有请求体

            ⚪POST：新增。—— 登录、注册主要使用。有请求体

            ⚪PUT：修改。—— 有请求体。

            ⚪DELETE: 删除。 —— 没有请求体

  • URL：数据资源的定位符。 协议://域名:端口/资源路径？查询参数&查询参数&...
  • 协议版本：指定HTTP协议的版本，HTTP/1.1或HTTP/1.2或HTTP/2.0，主要是HTTP/1.1。

https://i-blog.csdnimg.cn/direct/6e484ecfddf0418e8d6502df311c54c1.png" width="647" />

②请求头：

  • 作用：向服务器描述 客户端（浏览器）的基本信息。
  • 语法：都是“k：v”形式的 键值对儿，需要记的是两对

            ⚪User-Agent：向服务器描述浏览器的类型。

            ⚪Content-Type：向服务器描述 请求体 的数据类型！

https://i-blog.csdnimg.cn/direct/c248ff7516fb4769b807ef1d73fa2d86.png" width="530" />

https://i-blog.csdnimg.cn/direct/d47e9fe82dfc4e07b2d54e027355b6e3.png" width="652" />

③空一行：标识请求头结束了

④请求体

  • GET、DELETE请求方法，没有请求体。
  • POST、PUT 请求方法，有请求体。
  • 请求体的数据类型，受 请求头中 Content-Type 的值 影响

5️⃣http响应
  • 作用：由 服务器 回发送给 客户端；规定了 服务器回发给客户端的 数据的 语法格式！
  • 完整语法格式：响应行（状态行）、响应头、空行、响应体

https://i-blog.csdnimg.cn/direct/5305f8cc39d14539892430d432d8c133.png" width="596" />

https://i-blog.csdnimg.cn/direct/22182a2710164395b0902075c989787e.png" width="599" />

 ①状态行：

  • 语法格式：包含协议版本、状态码、状态码描述三部分

https://i-blog.csdnimg.cn/direct/f639cef800804141bca0d5f72605cc39.png" width="583" />

  • 协议版本：指示响应使用的HTTP协议版本HTTP/1.1或HTTP/1.2或HTTP/2.0，主要是HTTP/1.1。
  • 状态码：针对http请求，响应的状态

            ⚪1xx：信息类，表示请求已接受，继续处理

            ⚪2xx：成功。200 OK

            ⚪3xx：重定向。数据资源需要重定向访问

            ⚪4xx：客户端错误。404 Not Found 文件/资源 不存在。 403 Forbidden 文件/资源

                 存在，但是拒绝被访问（没有权限）

            ⚪5xx：服务器端错误。

  • 状态描述：对状态码的说明

https://i-blog.csdnimg.cn/direct/b18424f015c54d3caab3bc2dd2070e05.png" width="221" />

②响应头

  • 作用：向客户端描述 服务器的基本信息。
  • 语法：k:v 键值对儿
  • Content-Type：向客户端描述 响应体 的数据类型！

https://i-blog.csdnimg.cn/direct/19cdb12567bc4ee0880ac3c3440a2d4b.png" width="573" />

https://i-blog.csdnimg.cn/direct/7c430320f7554f85b0f816827ed1c87d.png" width="655" />

③空一行

④响应体

  • http响应报文，大多数报文都是有响应体！成功的话给数据，不成功的话告诉错误的类型。
  • 响应体的数据类型，受 响应头中 Content-Type 的值影响。
  • 常见的类型：

            ⚪json 类型

            ⚪表单 类型

            ⚪图片 类型 

  • https://i-blog.csdnimg.cn/direct/182d9a3e299c475880eac4b0355d16fa.png" width="546" />

四、传统风格和RESTful风格接口

1、传统风格接口

  • 使用GET、POST 实现所有数据的 增删改查操作。
  • 针对 用户的某一个操作，URL 不唯一。
  • 状态码 统一使用 200

https://i-blog.csdnimg.cn/direct/b29db7ae6e9a42678000063d862db4b6.png" width="585" />

好处： 

  • 对开发的技术要求低。 只需要 get、post 方法即可。
  • 代码实现灵活。

2、RESTful风格接口

一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。

REST:即(Representational State Transfer)的缩写。词组的翻译是“表现层状态转化”。如果-I个架构符合REST原则,就称它为RESTful架构。

  • 使用GET/POST/PUT/DELETE分别表示查、增、改、删
  • 使用一个URL对应一个唯一的资源。
  • 状态码，根据实际操作请求加以区分。

https://i-blog.csdnimg.cn/direct/8b1341e363f4406db4bdb5e9ccfbc167.png" width="601" />

界定RESTful风格接口：

  • 请求方法 使用 get、post、delete、put 对应 查、增、删、改
  • 数据资源的定位符（URL）是否 唯一。
  • 在 URL中，不使用动词，替换使用名词。结合 请求方法，界定具体操作。

五、接口测试的流程

https://i-blog.csdnimg.cn/direct/711ae38bd6c14c979e8200580386bc94.png" width="540" />

  • 1. 需求分析结合需求文档，需求分析
  • 2. 结合开发提供的接口文件（API文档，可以从开发拿，也可以抓包自己创建，也可以录制后自己创建），进行接口分析
  •      ①分析：接口地址，接口鉴权（鉴定是否有访问接口的权限）方式，接口入参，出参，是否有完善的错误码机制。
  • 3. 结合需求文档和API文档编写接口测试用例以及评审
  • 思路：
  •        正例：输入正常的入参，接口能够正常返回。(get/post)
  •        反例:
  •                鉴权反例：必填，鉴权码为空错误的鉴权码，鉴权码已过期……
  •                参数反例：必填，参数为为空，参数类型异常，参数的长度异常。
  •                错误码覆盖：根据业务而定。
  •                其他错误场景：接口黑名单，接口调用次数限制，分页场景。
  •                接口的兼容性：一个接口是否能兼容多个版本的前端。
  • 4. 执行接口测试用例
  •        工具：Postman、fiddler、jmeter
  •         代码：Python + UnitTest + requests
  • 5. 缺陷（bug）的管理和跟踪，回归i测试
  • 6. 生成测试报告
  • 7. Postman+Newman+Jenkins+git实现接口自动化持续集成（可选），并且生成测试报告和发送邮件（可选）。

1、接口文档

 1️⃣什么是接口文档

也叫 API 文档。是由开发人员编写。描述接口相关信息的文档。

2️⃣作用
  • 方便 前端开发人员和后端开发人员，在开发时进行对接。
  • 在人员更迭时，方便新入职的员工快速接手项目。
  • 方便测试人员编写接口测试用例。
3️⃣展现形式
  • 在线文档 （html）
  • 离线文档：word、xmind、pdf、Excel
4️⃣结构
  • 基本信息：

            ⚪接口描述
            ⚪URL：（协议+域名） + 资源路径
            ⚪请求方法：

  • 请求参数：

            ⚪请求头
            ⚪请求体（GET、DELETE 没有）

  • 返回结果：

            ⚪状态码、状态描述
            ⚪响应体

2、接口文档解析

1️⃣登录接口为例

http请求：

  • 请求行：

            ⚪请求方法：POST
            ⚪URL： http://ihrm-test.itheima.net/api/sys/login
            ⚪协议版本：默认 http/1.1

  • 请求头：

            ⚪Content-Type : application/json

  • 请求体：

            ⚪{ “mobile”：“13800000002”, ”password” : ”123456” }

http应答：

  • 响应行：

            ⚪状态码、状态描述：200 ok

  • 响应头：

            ⚪无

  • 响应体：

            ⚪第一种情况：{"success":true,"code":10000,"message":"操作成功！","data":"xxx"} 第一                   种情况
            ⚪第二种情况：{"success":false,"code":20001,"message":"用户名或密码错误","data":null}
            ⚪第三种情况：{"success":false,"code":99999,"message":"抱歉，系统繁忙，请稍后重
                 试！","data":null}

2️⃣员工修改接口为例 

http请求：

  • 请求行：

            ⚪请求方法：PUT
            ⚪URL：http://ihrm-test.itheima.net/api/sys/user/:target
            ⚪协议版本：默认 http/1.1

  • 请求头：

            ⚪Content-Type ：application/json
            ⚪Authorization ：Bearer f5050a1b-7919-444c-9ec4-3c1a7286536d

  • 请求体：

            ⚪{“username”：“张三”， “password”：“445566”， “departmentId”：“110”}
http应答：

  • 响应行：

            ⚪状态码、状态描述：200 ok

  • 响应头：

            ⚪无

  • 响应体：

            ⚪情况1，成功：{"success":true,"code":10000,"message":"操作成功！", "data":
                 {"id":"113749504"}}
            ⚪情况2，失败，权限不足：{"success":false,"code": 10003, "message":"权限不足！",                       "data":NULL}
            ⚪情况3，失败，系统繁忙：{"success":false,"code": 99999, "message":"抱歉，系统繁                     忙，请稍后重试！", "data": NULL}

全部内容：

Postman接口测试01|接口测试基础概念、http协议、RESTful风格、接口文档-CSDN博客

Postman接口测试02|接口用例设计_postman测试用例-CSDN博客

Postman接口测试03|执行接口测试、全局变量和环境变量、接口关联、动态参数、断言_postman内置动态参数-CSDN博客

Postman接口测试04|批量运行测试用例、参数化、Mock Server、Cookie鉴权、Newman生成测试报告-CSDN博客

 Postman接口测试05|实战项目笔记-CSDN博客


http://www.ppmy.cn/devtools/149906.html

相关文章

MongoDB中的索引是提高查询效率的重要工具

MongoDB中的索引是提高查询效率的重要工具

MongoDB中的索引是提高查询效率的重要工具&#xff0c;能够极大地优化数据检索过程。以下是对MongoDB索引设置的详细解释&#xff1a; 一、索引类型 单字段索引 在单个字段上建立的索引。对于单字段索引和排序操作&#xff0c;索引键的排序顺序&#xff08;升序或降序&#xf…
阅读更多...
通过氧化最小化工艺提高SiC MOSFET迁移率的深入分析

通过氧化最小化工艺提高SiC MOSFET迁移率的深入分析

标题 Insight Into Mobility Improvement by the Oxidation-Minimizing Process in SiC MOSFETs&#xff08;TED2024&#xff09; 文章的研究内容 文章的研究内容主要围绕氧化最小化工艺&#xff08;oxidation-minimizing process&#xff09;对碳化硅&#xff08;SiC&…
阅读更多...
《计算机视觉解锁图像理解密码：编程实现图片场景文字描述生成》

《计算机视觉解锁图像理解密码：编程实现图片场景文字描述生成》

《计算机视觉解锁图像理解密码&#xff1a;编程实现图片场景文字描述生成》 一、AI 时代的 “看图说话” 魔法二、基石之固&#xff1a;核心技术原理解析&#xff08;一&#xff09;图像识别先锋 —— 卷积神经网络&#xff08;CNN&#xff09;&#xff08;二&#xff09;文本创…
阅读更多...
MacOS带端口ping

MacOS带端口ping

在Mac上&#xff0c;原生的ping命令只能用于检测网络主机的连通性&#xff0c;它并不能直接ping某个特定的端口。为了ping某个端口&#xff0c;我们需要借助其他工具或方法。以下是两种在Mac上ping端口的方法&#xff1a; 1、使用telnet命令‌&#xff1a; telnet是一个网络协议…
阅读更多...
LLaMA-Factory web微调大模型并导出大模型

LLaMA-Factory web微调大模型并导出大模型

LLaMA-Factory 开源大模型如LLaMA&#xff0c;Qwen&#xff0c;Baichuan等主要都是使用通用数据进行训练而来&#xff0c;其对于不同下游的使用场景和垂直领域的效果有待进一步提升&#xff0c;衍生出了微调训练相关的需求&#xff0c;包含预训练&#xff08;pt&#xff09;&am…
阅读更多...
Windows使用AutoHotKey解决鼠标键连击现象（解决鼠标连击、单击变双击的故障）

Windows使用AutoHotKey解决鼠标键连击现象（解决鼠标连击、单击变双击的故障）

注&#xff1a;罗技鼠标&#xff0c;使用久了之后会出现连击现象&#xff0c;如果刚好过保了&#xff0c;可以考虑使用软件方案解决连击现象&#xff1a; 以下是示例AutoHotKey脚本&#xff0c;实现了调用XButton1用于关闭窗口&#xff08;以及WinW&#xff0c;XButton2也导向…
阅读更多...
Unity自带的真车模拟系统，速度不够大r时如何以匀速上桥

Unity自带的真车模拟系统，速度不够大r时如何以匀速上桥

在 Unity 中&#xff0c;如果你使用自带的真车模拟系统&#xff08;如 Wheel Collider&#xff09;时&#xff0c;发现车辆上桥时速度不够&#xff0c;导致无法顺利上坡&#xff0c;可以通过以下方法调整车辆的行为&#xff0c;使其能够以匀速上桥&#xff1a; 1. 调整 Wheel C…
阅读更多...
嵌入式C语言：什么是指针？

嵌入式C语言：什么是指针？

目录 一、指针的基本概念 1.1. 定义指针 1.2. 赋值给指针 1.3. 解引用指针 1.4. 指针运算 1.5. 空指针 1.6. 函数参数 1.7. 数组和指针 1.8. 示例代码 二、指针在内存中的表示 2.1. 内存地址存储 2.2. 内存模型 2.3. 指针与硬件交互 2.4. 示例代码 三 、指针的重…
阅读更多...
最新文章

Copyright @ 2022~2023