0
0

Postman：API测试、监控与性能测试全攻略

Postman：API测试、监控与性能测试全攻略

在这里插入图片描述

Postman基础入门

了解Postman及其功能

Postman是一款强大的API开发工具，它不仅帮助开发者构建、测试API，还支持API的修改、调试、发布和文档化。Postman的界面直观，功能全面，包括但不限于：

  • 发送HTTP请求：可以构建GET、POST、PUT、DELETE等HTTP请求。
  • 环境变量管理：轻松管理API测试中的变量，如URL、认证信息等。
  • 预请求脚本：在发送请求前执行JavaScript脚本，动态修改请求。
  • 测试脚本：在响应后执行脚本，验证API的正确性。
  • 集合：组织和管理多个API请求，便于批量测试和分享。
  • 监控：定期自动执行API请求，监控API的健康状况。
  • 性能测试：模拟大量用户并发请求，测试API的性能。

安装与配置Postman

安装Postman

  1. 访问Postman官方网站(https://www.postman.com/)。
  2. 选择适合你的操作系统（Windows、macOS或Linux）的版本进行下载。
  3. 安装程序并按照提示完成安装。

配置Postman

  1. 创建环境：在Postman中，可以通过“Manage Environments”来创建和管理环境变量，这对于测试不同环境下的API非常有用。- 点击“Manage Environments”按钮。- 选择“Add”来创建一个新的环境。- 输入环境名称，如“Development”或“Production”，并添加需要的变量。
  2. 设置全局变量：全局变量可以在所有请求中使用，无需在每个请求中重复定义。- 在环境管理界面，选择“Global”。- 添加全局变量，如“base_url”。
  3. 使用环境变量：在请求URL或请求头中，可以使用{{variable_name}}来引用环境变量。- 例如，请求URL可以设置为{{base_url}}/users。

创建第一个API请求

步骤1：新建请求

  1. 打开Postman，点击左上角的“+”按钮，选择HTTP请求类型（GET、POST等）。
  2. 在URL输入框中，输入API的URL，例如https://api.example.com/users。

步骤2：设置请求参数

  1. GET请求参数：如果使用GET请求，可以在URL中直接添加查询参数，如https://api.example.com/users?name=John&age=30。
  2. POST请求参数：对于POST请求，点击“Body”选项卡，选择“raw”模式，然后输入JSON格式的数据。{"name":"John","age":30}

步骤3：发送请求并查看响应

  1. 点击“Send”按钮发送请求。
  2. 在下方的响应区域，查看API返回的数据。

步骤4：添加测试脚本

  1. 在请求的“Tests”选项卡中，可以编写JavaScript脚本来验证响应。// 测试响应状态码是否为200pm.test("Status code is 200",function(){ pm.response.to.have.status(200);});// 测试响应中是否包含特定的JSON键pm.test("Response has a name",function(){var jsonData = pm.response.json(); pm.expect(jsonData).to.have.property('name');});

步骤5：保存请求

  1. 点击“Save”按钮，输入请求名称，如“Get Users”。
  2. 保存的请求可以放在不同的集合中，便于管理和分享。

通过以上步骤，你已经成功创建并测试了一个API请求。Postman的强大功能远不止于此，它还支持API的自动化测试、性能测试和监控，是API开发和测试的必备工具。

Postman: API测试实战

编写测试脚本

在Postman中，编写测试脚本是确保API按预期工作的重要步骤。Postman提供了JavaScript作为其测试脚本的语言，利用Postman的预构建函数和Chai断言库，可以轻松地创建和运行测试。

示例：验证响应状态码

// 使用Postman的pm对象来访问请求和响应信息
pm.test("响应状态码应为200",function(){// 断言响应状态码为200
    pm.response.to.have.status(200);});

示例：验证响应体中的特定值

// 假设API返回一个JSON对象，其中包含一个名为"message"的字段
pm.test("验证响应消息",function(){var jsonData = pm.response.json();// 断言message字段的值为"Hello, World!"
    pm.expect(jsonData.message).to.equal("Hello, World!");});

使用测试集合

测试集合是Postman中用于组织和运行多个测试的工具。通过创建测试集合，可以将多个测试脚本组合在一起，以确保API在各种情况下的表现。

创建测试集合

  1. 在Postman中，选择“Collections”选项卡。
  2. 点击右上角的“New”按钮创建一个新的集合。
  3. 在集合中添加请求，并为每个请求编写测试脚本。

运行测试集合

在集合中，选择“Runner”选项卡，可以运行整个集合或集合中的特定请求。Runner允许设置运行次数、延迟时间等参数，以模拟不同的测试场景。

运行测试与查看结果

运行测试后，Postman会显示测试结果，包括每个测试的状态（通过或失败）和任何错误信息。

查看测试结果

  1. 在Postman中，选择“Runner”选项卡。
  2. 运行测试集合后，结果将显示在“Runner”界面中。
  3. 可以查看每个请求的测试结果，以及整个测试集合的汇总信息。

示例：运行测试集合并查看结果

假设我们有一个测试集合，其中包含两个请求，每个请求都有一个测试脚本。运行测试集合后，Postman将显示每个请求的测试结果，以及整个集合的通过率。如果测试失败，Postman将提供详细的错误信息，帮助定位问题。

通过以上步骤，可以有效地在Postman中进行API测试，确保API的稳定性和可靠性。使用测试脚本和测试集合，可以自动化测试过程，节省时间并提高测试覆盖率。

Postman监控功能详解

设置API监控

在Postman中设置API监控，可以帮助你自动化地测试API的健康状况和性能。以下是设置API监控的步骤：

  1. 打开Postman，选择一个你想要监控的API请求或集合。
  2. 点击请求或集合旁边的“…”按钮，选择“设置监控”。
  3. 在弹出的窗口中，你可以设置监控的名称、描述、请求的URL、方法、以及任何必要的参数或头信息。
  4. 选择“高级设置”可以进一步配置监控的细节，如身份验证、预请求脚本和测试脚本。

示例：设置一个简单的API监控

假设我们有一个API，其URL为

https://api.example.com/data

，我们想要每5分钟监控一次，确保它返回的状态码为200。

- **监控名称**：Example API Health Check
- **监控URL**：https://api.example.com/data
- **监控频率**：5 minutes
- **触发条件**：无
- **监控结果分析**：检查状态码是否为200

监控频率与触发条件

Postman允许你自定义监控的频率，从每分钟到每天，甚至可以设置特定的时间点。触发条件则可以基于API的响应，如状态码、响应时间或响应内容。

监控频率设置

  • 每分钟：适合需要实时监控的API。
  • 每5分钟：适用于需要频繁检查但不需实时的API。
  • 每小时：适用于定期检查API状态的场景。
  • 每天：适用于低频但需要持续监控的API。

触发条件示例

假设我们想要监控API的响应时间，如果响应时间超过2秒，则发送通知。

// 这是一个Postman测试脚本示例，用于监控响应时间
pm.test("Response time is less than 2 seconds",function(){
    pm.expect(pm.response.responseTime).to.be.below(2000);});

监控结果分析

Postman会记录每次监控的详细结果，包括响应时间、状态码、以及任何自定义的测试结果。你可以通过Postman的监控面板查看这些结果，或者设置Webhook来接收监控结果的通知。

查看监控结果

  1. 在Postman中，点击左侧菜单的“监控”。
  2. 选择你设置的监控，可以看到最近的监控结果。
  3. 点击单个结果，可以查看详细的响应信息和测试结果。

设置Webhook接收通知

  1. 在监控设置中，选择“Webhook”选项。
  2. 输入你的Webhook URL，Postman会在每次监控后发送结果到这个URL。
  3. 你可以选择在成功或失败时发送Webhook，或者两者都发送。

示例：分析监控结果

假设我们监控的API在某次请求中返回了500状态码，这可能意味着服务器端出现了错误。在Postman的监控结果中，我们可以看到：

  • 状态码：500
  • 响应时间：1500 ms
  • 测试结果：失败，因为状态码不是200

这提示我们需要进一步检查服务器日志，找出导致500状态码的原因。

通过上述步骤和示例，你可以有效地在Postman中设置API监控，自定义监控频率和触发条件，以及分析监控结果，确保你的API始终处于最佳状态。

Postman：性能测试与Load Testing

理解性能测试的重要性

性能测试是软件测试的一个关键方面，旨在评估系统在特定负载下的行为，确保其能够满足性能目标。这包括测试系统的响应时间、吞吐量、资源利用率和稳定性。性能测试对于识别和解决瓶颈、优化资源使用、以及确保在高负载下系统仍能提供一致的用户体验至关重要。

为什么性能测试重要？

  1. 识别瓶颈：性能测试帮助识别系统中导致性能下降的组件或服务。
  2. 优化资源：通过测试，可以调整资源分配，如CPU、内存和网络带宽，以提高效率。
  3. 确保稳定性：测试系统在高负载下的稳定性，防止服务中断。
  4. 用户体验：保证在任何负载下，用户都能获得快速、可靠的响应。

使用Postman进行Load Testing

Postman提供了强大的工具来执行Load Testing，帮助测试API在高并发请求下的表现。这通过创建和运行虚拟用户来模拟负载完成。

设置Load Testing

  1. 创建请求：首先，在Postman中创建一个或多个API请求。
  2. 设置测试场景：使用“Runner”或“Newman”工具，定义测试的持续时间、虚拟用户数量和请求频率。
  3. 运行测试：执行测试场景，Postman将模拟多个用户同时发送请求。

示例：使用Newman进行Load Testing

# 使用Newman运行Load Testing
newman run <collection-id>-e<environment-id>-n<number-of-requests>-r<reporter-type>
  • <collection-id>：Postman集合的ID。
  • -e <environment-id>：测试环境的ID。
  • -n <number-of-requests>：要发送的请求总数。
  • -r <reporter-type>：报告的类型，如HTML或JSON。

解析命令

假设我们有一个名为

API-Testing

的集合，环境为

Staging

，计划发送1000个请求，并希望以HTML格式生成报告：

newman run API-Testing -e Staging -n1000-r html --reporter-html-export performance-report.html

分析性能测试报告

Postman的性能测试报告提供了详细的洞察，包括请求的响应时间、失败率、吞吐量等。这些数据对于理解API在不同负载下的行为至关重要。

报告的关键指标

  1. 平均响应时间：所有请求的平均响应时间。
  2. 失败率：未能成功响应的请求比例。
  3. 吞吐量：单位时间内成功处理的请求数量。
  4. 资源使用：服务器资源（如CPU和内存）的使用情况。

示例：解读报告

假设测试报告显示平均响应时间为200ms，失败率为0%，吞吐量为100请求/秒。这表明API在测试的负载下表现良好，能够快速响应且没有失败请求。

进一步分析

  • 响应时间分布：检查响应时间的分布，识别是否有异常高的响应时间。
  • 错误类型：分析失败请求的具体错误类型，如404或500错误。
  • 资源监控：结合服务器监控工具，分析资源使用情况，识别潜在的瓶颈。

通过这些步骤，可以全面评估API的性能，并采取措施优化其表现。

高级测试技巧与最佳实践

测试环境变量

在Postman中，环境变量允许你存储和管理API测试中经常使用的值，如URL、API密钥、数据库连接字符串等。这不仅提高了测试的可维护性，也使得在不同环境（如开发、测试、生产）之间切换变得更加容易。下面是如何在Postman中设置和使用环境变量的步骤：

  1. 创建环境：在Postman的左侧面板中，点击“Manage Environments”按钮，然后点击“Add”来创建一个新的环境。你可以为环境命名，例如“Development”。
  2. 定义变量：在环境编辑界面，你可以添加变量。例如，添加一个名为base_url的变量，值为https://dev.example.com/api。
  3. 在请求中使用变量：在请求URL中，你可以使用双大括号{{variable_name}}来引用环境变量。例如，你的请求URL可以是{{base_url}}/users。
  4. 切换环境：在Postman的请求构建器顶部，你可以选择不同的环境，Postman会自动替换请求中的变量值。

示例

假设我们有一个API，其URL在开发和生产环境有所不同。我们可以创建两个环境，分别存储这两个URL。

// Development Environment
base_url: https://dev.example.com/api

// Production Environment
base_url: https://prod.example.com/api

然后，在Postman中构建请求时，使用

{{base_url}}

来引用这些变量：

GET {{base_url}}/users

这样，无论你选择哪个环境，Postman都会自动使用正确的URL。

使用Postman Newman自动化测试

Newman是Postman的命令行集合运行器，可以用于自动化执行Postman集合。这对于持续集成/持续部署（CI/CD）流程特别有用，因为它允许你在没有图形界面的情况下运行测试。

安装Newman

首先，确保你已经安装了Node.js。然后，在命令行中运行以下命令来全局安装Newman：

npminstall-g newman

运行集合

假设你有一个Postman集合，名为

API Tests

，你可以使用以下命令来运行它：

newman run "API Tests"

集成CI/CD

在CI/CD流程中，你可以在构建脚本中调用Newman，例如在Jenkins、Travis CI或GitHub Actions中。下面是一个在GitHub Actions中使用Newman的示例：

name: Run API Tests
on:push:branches:- main

jobs:test:runs-on: ubuntu-latest
    steps:-name: Checkout code
        uses: actions/checkout@v2
      -name: Run API Tests
        run:|
          npm install -g newman
          newman run "API Tests" --reporters cli,junit --reporter-junit-export junit.xml

在这个示例中，每当代码被推送到

main

分支时，GitHub Actions就会触发一个工作流，运行API测试集合，并生成Junit格式的报告。

Postman与CI/CD集成

将Postman集成到CI/CD流程中，可以确保每次代码更改后，API的测试都会自动运行，从而提高代码质量和部署速度。

配置Postman环境

在Postman中，你可以创建不同的环境，每个环境包含特定的变量，如API URL、数据库连接等。这些环境可以被Newman使用，以适应不同的测试场景。

在CI/CD中使用Newman

在CI/CD工具中，如Jenkins、GitLab CI或GitHub Actions，你可以配置一个任务或步骤来运行Newman。这通常涉及到以下步骤：

  1. 下载Postman集合：从你的代码仓库中下载包含Postman集合的文件。
  2. 运行Newman：使用Newman运行下载的集合。
  3. 报告测试结果：将Newman的测试结果报告给CI/CD工具，以便于查看和分析。

示例：在Jenkins中集成Postman

在Jenkins中，你可以创建一个新的构建任务，并在构建步骤中使用Shell命令来运行Newman。下面是一个示例Jenkinsfile：

pipeline {
    agent any
    stages {stage('Run API Tests'){
            steps {
                sh 'npm install -g newman'
                sh 'newman run "API Tests" --environment "Development" --reporters cli,junit --reporter-junit-export junit.xml'}}}}

在这个示例中，Jenkins首先安装Newman，然后使用

Development

环境运行

API Tests

集合，并生成Junit格式的报告。

通过以上步骤，你可以有效地在Postman中使用环境变量，自动化测试API，并将其无缝集成到CI/CD流程中，从而提高测试效率和代码质量。

故障排查与优化

常见错误与解决方案

在使用Postman进行API测试时，遇到错误是不可避免的。了解常见错误及其解决方案可以帮助您更高效地进行测试。以下是一些常见的错误类型及其解决方法：

1. 404 Not Found

  • 原因：请求的URL不存在或资源未找到。
  • 解决方案：确认URL是否正确。检查API文档或与API提供者确认资源路径。

2. 401 Unauthorized

  • 原因：请求未被授权，通常是因为缺少或错误的认证信息。
  • 解决方案：在Postman中设置正确的认证方式，如Basic Auth、Bearer Token等，并确保认证信息正确无误。

3. 500 Internal Server Error

  • 原因：服务器端发生错误，无法完成请求。
  • 解决方案：检查请求体是否符合API的预期格式，或联系API提供者确认服务器状态。

4. 超时错误

  • 原因：请求在规定时间内未得到响应。
  • 解决方案：增加请求的超时时间，或优化API性能以减少响应时间。

优化测试性能

为了提高Postman中的API测试性能，可以采取以下策略：

1. 使用环境变量

  • 描述：环境变量允许您在不同的测试环境中（如开发、测试、生产）使用相同的测试集合，只需更改变量值即可。
  • 示例：在Postman中创建一个环境，定义如`base_url`这样的变量，然后在请求URL中使用`{{base_url}}`来引用它。

2. 预构建脚本

  • 描述：预构建脚本在请求发送前执行，可以用来设置动态数据或请求头。
  • 示例：// 设置动态请求头pm.request.headers.add({key:'Authorization',value:'Bearer '+ pm.environment.get('access_token'),type:'text'});

3. 测试脚本优化

  • 描述：优化测试脚本可以减少不必要的计算，提高测试速度。
  • 示例：// 使用更高效的字符串拼接var message ='Hello '+ pm.environment.get('user_name');

测试结果的深入分析

深入分析测试结果可以帮助您更好地理解API的行为，识别潜在问题。以下是一些分析技巧：

1. 响应时间分析

  • 描述：检查响应时间可以帮助您评估API的性能。
  • 示例：// 计算响应时间var responseTime = pm.response.responseTime;console.log('Response Time: '+ responseTime +'ms');

2. 响应状态码检查

  • 描述：检查响应状态码可以确保API按预期工作。
  • 示例：// 检查响应状态码pm.test("Status code is 200",function(){ pm.response.to.have.status(200);});

3. 响应体验证

  • 描述：验证响应体中的数据是否符合预期，可以使用JSON Schema或自定义验证函数。
  • 示例：// 验证响应体pm.test("Body matches string",function(){ pm.expect(pm.response.text()).to.include("success");});

通过以上方法，您可以有效地在Postman中进行故障排查，优化测试性能，并深入分析测试结果，从而提高API测试的效率和准确性。

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

“Postman：API测试、监控与性能测试全攻略”的评论:

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

功能安全实战系列-DFA(Dependent Failure Analysis)分析

Apifox接口项目搭建、管理优化方案报告

关于Pycharm 2024 激活出现的问题

VSCode Git Graph 插件使用教程

RabbitMQ 优点和缺点

Kafka 的零拷贝原理

Hadoop的汽车销量数据分析系统

文章导航