0
0

Postman：Postman API测试：Postman中创建第一个API请求

Postman：Postman API测试：Postman中创建第一个API请求

在这里插入图片描述

介绍Postman基础

Postman的安装与启动

Postman是一款强大的API开发工具，它可以帮助开发者构建、测试和修改API。要开始使用Postman，首先需要从其官方网站下载并安装适合您操作系统的版本。安装过程简单直观，只需按照屏幕上的指示进行即可。安装完成后，启动Postman，您将看到一个用户友好的界面，准备开始您的API测试之旅。

Postman界面概览

Postman的界面主要分为以下几个部分：

  1. 请求类型选择器：位于界面顶部，可以选择GET、POST、PUT、DELETE等HTTP请求方法。
  2. URL输入框：紧邻请求类型选择器，用于输入您要测试的API的URL。
  3. 头部信息：可以在此处添加请求头，如Content-Type、Authorization等。
  4. 请求体：对于POST、PUT等请求，可以在此处输入或上传请求体数据。
  5. 预请求脚本：用于在发送请求前执行一些脚本，如设置变量、修改请求等。
  6. 测试脚本：在响应后执行，用于验证API的响应是否符合预期。
  7. 发送按钮：点击后，Postman将发送构建好的请求，并显示API的响应。
  8. 响应区：显示API的响应数据，包括状态码、响应头和响应体。

理解API与HTTP请求

API（Application Programming Interface）是应用程序接口的缩写，它定义了不同软件组件之间如何通信。在Web开发中，API通常指的是Web API，它允许不同的Web应用通过HTTP协议进行数据交换。

HTTP（Hypertext Transfer Protocol）是用于从Web服务器传输超文本到本地浏览器的传输协议。HTTP请求是客户端（如Postman）向服务器发送的请求，请求可以是GET、POST、PUT、DELETE等类型。GET请求用于从服务器获取数据，而POST请求用于向服务器发送数据。

示例：创建一个GET请求

假设我们想要从一个公开的API获取天气信息，API的URL如下：

https://api.openweathermap.org/data/2.5/weather?q=London&appid=YOUR_API_KEY

在Postman中创建GET请求的步骤如下：

  1. 选择GET请求类型。
  2. 在URL输入框中输入上述URL，确保替换YOUR_API_KEY为您从OpenWeatherMap获取的API密钥。
  3. 点击发送按钮，Postman将发送请求并显示响应。
示例：创建一个POST请求

假设我们有一个API，用于创建新的用户账户，API的URL如下：

https://example.com/api/users

我们需要在请求体中发送用户数据，数据格式如下：

{"name":"John Doe","email":"[email protected]","password":"securepassword"}

在Postman中创建POST请求的步骤如下：

  1. 选择POST请求类型。
  2. 在URL输入框中输入https://example.com/api/users。
  3. 点击请求体区域，选择raw选项，并从下拉菜单中选择JSON。
  4. 在请求体中输入上述JSON数据。
  5. 点击发送按钮，Postman将发送请求并显示响应。

通过以上步骤，您已经了解了如何在Postman中创建和发送API请求。接下来，您可以开始探索更高级的功能，如环境变量、集合和测试脚本，以更有效地测试和管理您的API。

创建API请求

在Postman中创建API请求是进行API测试的基础步骤。本教程将详细指导你如何在Postman中设置请求方法、输入请求URL、添加请求头以及处理请求参数，帮助你快速上手API测试。

设置请求方法

Postman允许你选择不同的HTTP请求方法，包括GET、POST、PUT、DELETE等。选择正确的请求方法对于API测试至关重要。

步骤

  1. 打开Postman，创建一个新的请求。
  2. 在顶部的下拉菜单中选择请求方法。

示例

假设我们要向一个API发送一个POST请求，以创建一个新的用户账户。

请求方法: POST

输入请求URL

URL是API的地址，输入正确的URL是确保请求能够到达正确端点的关键。

步骤

  1. 在请求方法下方的输入框中，输入API的URL。
  2. 确保URL正确无误，包括任何必要的路径参数。

示例

假设API的URL为

https://api.example.com/users

。

请求URL: https://api.example.com/users

添加请求头

请求头包含了API调用时需要的额外信息，如认证信息、数据格式等。

步骤

  1. 在请求编辑器中，点击“Headers”选项卡。
  2. 点击右下角的“Add Header”按钮。
  3. 输入键值对，键通常是预定义的，如Content-Type，值则根据API的要求填写。

示例

假设API要求数据以JSON格式发送。

请求头:
- Key: Content-Type
- Value: application/json

在Postman中，你将这样添加：
KeyValueContent-Typeapplication/json

处理请求参数

请求参数可以是查询参数或请求体中的参数，用于向API传递数据。

步骤

  1. 查询参数：在请求编辑器中，点击“Params”选项卡，添加键值对。
  2. 请求体参数：在请求编辑器中，点击“Body”选项卡，选择“raw”模式，然后输入JSON或XML格式的数据。

示例

假设我们需要向API传递一个查询参数

id

和一个请求体参数

user

。

查询参数
查询参数:
- Key: id
- Value: 12345

在Postman中，你将这样添加：
KeyValueid12345

请求体参数
{"user":{"name":"John Doe","email":"[email protected]"}}

在Postman的“Body”选项卡中，选择“raw”模式，并在输入框中粘贴上述JSON数据。

通过以上步骤，你可以在Postman中创建一个完整的API请求，包括设置请求方法、输入请求URL、添加请求头以及处理请求参数。这将为你的API测试打下坚实的基础。

Postman：在Postman中创建并分析API请求

发送请求

在Postman中创建并发送API请求是开始API测试的第一步。以下步骤将指导你如何在Postman中创建并发送一个GET请求到一个公开的API，例如JSONPlaceholder，这是一个用于测试和原型设计的免费在线API。

  1. 打开Postman并创建新请求: 打开Postman应用，点击左上角的+按钮创建一个新的请求。
  2. 选择请求类型: 在新打开的请求窗口中，选择GET作为请求类型。
  3. 输入API URL: 在URL输入框中，输入API的URL。例如，我们将使用JSONPlaceholder的用户列表API:https://jsonplaceholder.typicode.com/users
  4. 发送请求: 点击Send按钮发送请求。

示例代码

假设你正在使用Postman的内置代码生成器来创建一个使用Node.js的请求，以下是一个示例代码：

// 引入http请求库const axios =require('axios');// API URLconst url ='https://jsonplaceholder.typicode.com/users';// 发送GET请求
axios.get(url).then(response=>{// 打印响应数据
    console.log(response.data);}).catch(error=>{// 打印错误信息
    console.error(error);});

查看响应

发送请求后，Postman将显示API的响应。响应通常包括状态码、响应头和响应体。

  1. 状态码: 状态码位于响应顶部，表示请求的结果。例如，200表示成功，404表示未找到资源。
  2. 响应头: 响应头包含有关响应的元数据，如内容类型、编码等。
  3. 响应体: 响应体包含API返回的实际数据。对于JSON响应，Postman会自动格式化数据，使其更易于阅读。

示例响应

对于上面的GET请求，JSONPlaceholder返回的响应可能如下所示：

[{"id":1,"name":"Leanne Graham","username":"Bret","email":"[email protected]",// 更多数据...},// 更多用户数据...]

分析响应状态码

响应状态码是API通信中非常重要的部分，它告诉请求者请求是否成功，以及如果失败，失败的原因是什么。以下是一些常见的HTTP状态码及其含义：

  • 200 OK: 请求成功，响应包含请求的数据。
  • 400 Bad Request: 请求有语法错误或无法被服务器理解。
  • 401 Unauthorized: 请求要求用户的身份认证。
  • 403 Forbidden: 服务器理解请求客户端的请求，但是拒绝执行此请求。
  • 404 Not Found: 请求的资源不存在。

如何在Postman中分析状态码

在Postman中，状态码会直接显示在响应的顶部。你可以通过以下步骤来分析状态码：

  1. 发送请求: 点击Send按钮发送请求。
  2. 检查状态码: 在响应顶部查看状态码。如果状态码是200，则表示请求成功。
  3. 使用断言: 在Postman中，你可以使用测试脚本来断言状态码。例如，你可以添加以下JavaScript代码到请求的Tests面板中：
// 断言响应状态码为200
pm.test("Status code is 200",function(){
    pm.response.to.have.status(200);});

通过以上步骤，你可以在Postman中创建并发送API请求，查看响应，并分析响应状态码，从而确保API按预期工作。这为API测试和调试提供了强大的工具。

使用Postman进行API测试

编写测试脚本

在Postman中，测试脚本是用于自动化API测试的关键组件。它们允许你验证API响应是否符合预期，检查数据的完整性，以及执行更复杂的测试逻辑。Postman使用JavaScript作为其测试脚本的语言，通过预请求脚本和测试脚本来增强请求和响应的处理能力。

预请求脚本

预请求脚本在发送请求之前运行，可以用来设置动态请求参数、修改请求头或执行任何必要的预处理。例如，如果你需要在每次请求前生成一个随机的用户ID，可以使用以下预请求脚本：

// 生成随机用户IDconst userId = Math.floor(Math.random()*10000);
pm.environment.set("userId", userId.toString());

测试脚本

测试脚本在收到响应后运行，用于验证响应数据。你可以使用Postman内置的

pm.test

函数来添加断言，检查响应状态码、响应时间、响应体中的特定值等。下面是一个简单的测试脚本示例，它检查响应状态码是否为200，并验证响应体中是否存在特定的JSON键：

pm.test("Status code is 200",function(){
    pm.response.to.have.status(200);});

pm.test("Body contains userId",function(){const responseJson = pm.response.json();
    pm.expect(responseJson).to.have.property('userId');});

使用断言验证响应

断言是测试脚本的核心，用于检查API响应是否满足特定条件。Postman提供了多种内置的断言方法，如

pm.response.to.have.status()

用于验证状态码，

pm.expect()

用于验证响应体中的数据。

验证状态码

确保API调用成功，通常需要验证响应状态码。例如，一个成功的GET请求通常返回200状态码：

pm.test("Status code is 200",function(){
    pm.response.to.have.status(200);});

验证响应时间

API的响应时间是性能测试的重要指标。你可以设置一个最大响应时间，并使用

pm.response.to.have.responseTime

来验证：

pm.test("Response time is less than 2000ms",function(){
    pm.response.to.have.responseTime.below(2000);});

验证响应体

验证响应体中的数据可以确保API返回了预期的信息。例如，检查响应体中是否存在特定的JSON键和值：

pm.test("Body contains correct userId",function(){const responseJson = pm.response.json();
    pm.expect(responseJson.userId).to.eql(pm.environment.get("userId"));});

查看测试结果

在Postman中，测试结果会显示在请求发送后的“Test Results”面板中。这里会列出所有执行的测试脚本及其结果，包括通过或失败的状态，以及任何相关的错误信息。

分析测试结果

测试结果面板提供了详细的测试输出，包括每个测试的执行情况。如果测试失败，面板会显示失败的测试名称和原因，帮助你快速定位问题。

保存测试结果

Postman允许你保存测试结果，以便后续分析或分享给团队成员。你可以通过点击“Save”按钮来保存测试结果，或者使用集合运行器来批量运行测试并导出结果。

集合运行器

集合运行器是Postman中用于批量运行请求和测试的强大工具。它允许你设置运行次数、延迟时间，并可以将测试结果导出为CSV或HTML格式，便于进一步分析或报告。

通过以上步骤，你可以在Postman中有效地创建和管理API测试，确保API的稳定性和可靠性。使用测试脚本和断言，你可以自动化测试过程，提高测试效率，同时通过查看和分析测试结果，及时发现和解决问题。

高级功能概览

在Postman中，除了基本的API请求创建和发送，还有一系列高级功能可以帮助你更高效地进行API测试、管理和协作。本教程将深入探讨这些功能，包括集合与环境的使用、Postman Runner的运行机制，以及如何导出与分享请求。

集合与环境

集合

集合是Postman中组织和管理API请求的一种方式。你可以将相关的请求分组到一个集合中，便于测试整个API的流程。集合支持保存请求、运行测试、生成文档等功能。

创建集合
  1. 在Postman的左侧菜单中，点击+创建一个新的集合。
  2. 输入集合名称，例如“用户管理API”。
  3. 点击Create按钮。
添加请求到集合
  1. 在集合中点击+添加请求。
  2. 输入请求名称，例如“获取用户列表”。
  3. 选择请求方法（GET、POST等）。
  4. 输入请求URL。
  5. 添加必要的请求头、参数或body。
  6. 点击Send发送请求。
运行集合
  1. 选择一个集合。
  2. 点击Runner按钮。
  3. 选择运行的请求、次数和环境。
  4. 点击Start Run开始运行。

环境

环境用于存储API测试中常用的变量和配置，如URL、API密钥等。通过环境，你可以轻松切换测试、开发和生产环境，而无需修改每个请求的设置。

创建环境
  1. 在Postman顶部菜单中，点击Manage Environments。
  2. 点击Add创建新环境。
  3. 输入环境名称，例如“开发环境”。
  4. 添加变量，如base_url，并设置其值。
  5. 点击Save保存环境。
使用环境变量

在请求URL或请求头中，你可以使用环境变量。例如，如果

base_url

的值是

https://api.example.com

，你可以这样设置请求URL：

{{base_url}}/users

使用Postman Runner

Postman Runner是一个强大的工具，用于运行集合中的请求序列，可以设置循环次数、延迟时间等，非常适合自动化测试。

设置Runner
  1. 选择一个集合。
  2. 点击Runner按钮。
  3. 在Runner界面中，选择要运行的请求。
  4. 设置循环次数和延迟时间。
  5. 点击Start Run开始运行。
查看Runner结果

运行结束后，Runner会显示每个请求的状态码、响应时间、测试结果等详细信息，帮助你快速定位问题。

导出与分享请求

导出请求

在Postman中，你可以将请求或集合导出为JSON文件，便于备份或在其他Postman实例中导入。

导出步骤
  1. 选择一个请求或集合。
  2. 点击Export按钮。
  3. 选择导出格式，通常是Collection v2.1。
  4. 点击Export导出文件。

分享请求

Postman还支持通过链接分享请求或集合，便于团队成员协作。

分享步骤
  1. 选择一个请求或集合。
  2. 点击Share按钮。
  3. 选择分享方式，如通过链接或嵌入代码。
  4. 设置访问权限，如公开或仅限团队成员。
  5. 点击Copy复制分享链接。

通过以上高级功能的使用，Postman不仅是一个强大的API测试工具，也是一个促进团队协作和提高测试效率的平台。掌握这些功能，将使你在API测试中更加得心应手。

Postman API测试：在Postman中创建第一个API请求

回顾API请求流程

在Postman中创建API请求是一个直观且直接的过程，它帮助开发者和测试人员快速地与API进行交互。以下是创建API请求的基本步骤：

  1. 打开Postman：启动Postman应用，进入主界面。
  2. 选择请求类型：在顶部的下拉菜单中选择请求类型，如GET、POST、PUT、DELETE等。
  3. 输入请求URL：在URL输入框中，输入你想要测试的API的URL。
  4. 设置请求参数：根据API的需求，可以在不同的面板中设置参数，如查询参数、请求体、头部信息等。
  5. 发送请求：点击“Send”按钮，Postman将向指定的URL发送请求。
  6. 查看响应：在下方的响应面板中，可以查看API返回的数据和状态码。
  7. 验证响应：使用Postman的测试脚本功能，可以自动验证API的响应是否符合预期。
  8. 保存请求：如果需要重复使用请求，可以将其保存到集合中。
  9. 创建集合：将多个相关的请求组织到一个集合中，便于管理和共享。
  10. 运行测试：使用集合运行器，可以自动化执行一系列的请求和测试。

探索更多Postman功能

Postman提供了丰富的功能，以支持API的开发、测试和调试。以下是一些高级功能的介绍：

1. 环境变量

环境变量允许你在不同的环境中（如开发、测试、生产）使用相同的请求，只需更改URL或参数。例如，你可以设置一个环境变量

{{base_url}}

，并在请求URL中使用它，如

{{base_url}}/users

。

2. 预请求脚本

预请求脚本是在发送请求之前运行的JavaScript代码，可以用来设置动态参数或执行其他初始化任务。例如，你可以使用预请求脚本来生成一个随机的用户ID：

// 设置随机用户IDconst userId = Math.floor(Math.random()*1000);
pm.environment.set("userId", userId);

3. 测试脚本

测试脚本用于验证API响应是否符合预期。你可以使用

pm.test

函数来编写测试。例如，验证响应状态码是否为200：

pm.test("Status code is 200",function(){
    pm.response.to.have.status(200);});

4. 集合运行器

集合运行器可以自动化执行一系列的请求，这对于执行API测试非常有用。你可以在运行器中设置循环次数、延迟时间等参数。

5. 监控

Postman的监控功能允许你定期自动运行集合，以监控API的健康状况和性能。

6. Postman API

Postman API允许你通过代码来控制Postman，例如，你可以编写脚本来自动化创建请求、集合或运行测试。

开始构建自己的API测试项目

构建API测试项目时，建议遵循以下步骤：

  1. 定义测试目标：明确你想要测试的API的功能和性能指标。
  2. 创建请求：使用Postman创建API请求，确保覆盖所有测试点。
  3. 编写测试脚本：为每个请求编写测试脚本，验证响应数据和状态码。
  4. 设置环境变量：使用环境变量来管理不同的测试环境。
  5. 组织到集合：将请求组织到集合中，便于管理和共享。
  6. 运行测试：使用集合运行器自动化执行测试。
  7. 分析结果：查看测试结果，分析API的性能和稳定性。
  8. 持续监控：设置监控，定期检查API的健康状况。

通过以上步骤，你可以有效地在Postman中构建和执行API测试项目，确保API的质量和稳定性。

标签： postman lua 测试工具
本文转载自: https://blog.csdn.net/weixin_42749425/article/details/142322420
版权归原作者 kkchenjj 所有， 如有侵权，请联系我们删除。
登录后发布评论

“Postman：Postman API测试：Postman中创建第一个API请求”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

自动驾驶安全方向论文阅读

【Linux】————多线程（概念及控制）

即时设计初学者指南，零基础入门必看

初探Flink的序列化

502 Bad Gateway 错误详解：从表现推测原因，逐步排查直至解决

2024 年 MySQL 8.0 安装 配置 教程 最简易（保姆级）

Windsurf：这款全新免费的 AI IDE 击败了Cursor 吗？超强上下文感知 、AI代理和工作流支持

文章导航