Postman：Postman简介：Postman高级技巧与最佳实践

在这里插入图片描述

Postman概述

Postman的功能与优势

Postman是一款强大的API开发工具，它不仅简化了API的测试过程，还提供了API开发的完整生命周期支持。以下是Postman的一些关键功能和优势：

API测试：Postman允许你构建、发送HTTP请求，检查响应，进行自动化测试。
API构建与修改：通过直观的界面，你可以轻松构建复杂的HTTP请求，包括GET、POST、PUT、DELETE等方法。
环境变量：Postman支持环境变量，可以轻松切换不同的环境（如开发、测试、生产）。
集合与迭代：集合功能帮助你组织和管理多个请求，迭代功能则可以运行这些集合进行批量测试。
监控与集成：Postman可以监控API的性能，并与各种工具和服务（如GitHub、Jenkins）集成。
文档与协作：它提供了API文档的自动生成，以及团队协作功能，便于团队成员共享和协作。

示例：使用Postman发送GET请求

# 打开Postman，创建一个新的GET请求。# 在URL栏中输入：https://jsonplaceholder.typicode.com/todos/1# 点击发送按钮，Postman将显示响应数据。

Postman的安装与基本界面介绍

安装Postman

访问Postman官网（https://www.postman.com/downloads/）下载适合你操作系统的版本。
安装下载的安装包，按照提示完成安装过程。
启动Postman，首次启动可能需要创建账户或登录。

基本界面介绍

Postman的界面直观且功能丰富，主要组成部分包括：

顶部菜单栏：包含文件、编辑、视图、集合、帮助等菜单。
请求构建器：位于界面中央，用于构建HTTP请求，包括选择请求方法、输入URL、添加头部、参数、Body等。
预请求脚本与测试脚本：用于编写JavaScript代码，可以在发送请求前或接收响应后执行。
响应查看器：展示API的响应数据，支持JSON、XML、HTML等多种格式。
集合与环境：集合用于组织请求，环境用于管理变量和配置。
监视器与集成：监视器用于监控API性能，集成则连接外部工具和服务。

示例：创建一个环境

// 在Postman中创建环境的示例代码// 这段代码用于设置环境变量，通常在Postman中直接通过界面操作完成，但这里展示如何通过代码设置。// 假设我们有一个环境变量需要设置，例如API的base URL// 在Postman中，你可以通过以下方式设置环境变量：
pm.environment.set("apiBaseUrl","https://api.example.com");// 然后在请求的URL中，你可以使用这个环境变量// 例如，发送一个GET请求到/api/v1/users
pm.sendRequest({url: pm.environment.get("apiBaseUrl")+"/api/v1/users",method:"GET"},function(err, res){
  console.log(res.text());});

通过上述内容，你已经对Postman的功能与优势有了初步了解，并掌握了如何安装Postman以及其基本界面的使用方法。接下来，你可以开始探索Postman的更多高级功能和最佳实践，以更高效地进行API开发和测试。

Postman 高级技巧

使用环境变量和全局变量

在Postman中，环境变量和全局变量是用于存储和重用数据的强大工具，它们可以简化测试过程，提高效率。环境变量适用于特定的环境，而全局变量则在整个Postman应用中可用。

环境变量

环境变量可以存储如URL、端口、认证信息等，这些信息在不同的测试环境中可能有所不同。例如，你可能有一个开发环境和一个生产环境，每个环境的API URL都不同。通过设置环境变量，你可以在测试时轻松切换环境，而无需手动更改每个请求的URL。

如何使用环境变量

创建环境：在Postman中，点击“Manage Environments”按钮，然后点击“Add”来创建一个新的环境。例如，创建一个名为“Development”的环境。
定义变量：在环境编辑界面，你可以定义变量。例如，定义一个名为apiUrl的变量，值为https://dev.example.com/api。
在请求中使用变量：在请求的URL中，你可以使用{{variableName}}来引用环境变量。例如，请求URL可以设置为{{apiUrl}}/users。

全局变量

全局变量在整个Postman应用中可用，适用于所有环境。它们可以存储一些不变的数据，如常量、版本号等。

如何使用全局变量

创建全局变量：在“Manage Environments”界面，点击“Globals”标签，然后添加一个全局变量。例如，添加一个名为version的全局变量，值为1.0。
在请求中使用全局变量：与环境变量类似，你可以在请求中使用{{variableName}}来引用全局变量。例如，请求URL可以设置为https://api.example.com/v{{version}}/users。

构建复杂的请求与预请求脚本

Postman允许你在请求中使用预请求脚本来执行一些初始化任务，如设置请求头、生成动态数据等。这在测试需要复杂设置的API时非常有用。

预请求脚本示例

假设你需要测试一个API，该API需要一个动态生成的token作为请求头的一部分。你可以使用预请求脚本来生成这个token。

// Pre-request script to generate a tokenconst timestamp =newDate().getTime();const secret ='your-secret-key';const hash = CryptoJS.HmacSHA256(timestamp, secret).toString();// Set the token in the request header
pm.environment.set("token", hash);

在这个例子中，我们使用了

CryptoJS

库来生成一个基于时间戳和秘密密钥的HMAC-SHA256哈希值。然后，我们将生成的token存储在环境变量中，以便在请求头中使用。

利用Postman的测试功能进行自动化测试

Postman的测试功能允许你自动化测试API响应，确保API按预期工作。你可以编写测试脚本来检查响应状态、响应体中的数据等。

测试脚本示例

假设你正在测试一个返回用户信息的API，你想要确保响应状态码为200，并且响应体中包含用户的email。

// Test script to check response status and data
pm.test("Status code is 200",function(){
    pm.response.to.have.status(200);});

pm.test("Response contains email",function(){const responseJson = pm.response.json();
    pm.expect(responseJson.email).to.be.a('string');});

在这个例子中，我们使用了

pm.test

函数来定义测试。第一个测试检查响应状态码是否为200，第二个测试检查响应体中是否包含email字段，并且它是一个字符串。

Postman集合的创建与管理

Postman集合是组织和管理API请求的工具。你可以将相关的请求分组到一个集合中，然后使用集合运行器来自动化执行这些请求。

创建集合

新建集合：在Postman中，点击“New”按钮，选择“Collection”来创建一个新的集合。
添加请求：在集合中，你可以添加新的请求。为每个请求设置URL、方法、请求头和请求体。
设置测试脚本：在每个请求中，你可以设置测试脚本来自动化测试。

管理集合

编辑集合：你可以随时编辑集合，添加、删除或修改请求。
共享集合：集合可以导出为JSON文件，然后通过电子邮件或云存储共享给团队成员。
使用集合运行器：集合运行器允许你自动化执行集合中的请求。你可以设置运行器来重复执行请求，或者在不同的环境中运行。

通过以上高级技巧，你可以更高效地使用Postman来测试和管理API。

Postman高级技巧与最佳实践

最佳实践

设计RESTful API的测试策略

原理

设计RESTful API的测试策略时，重要的是确保API的每个端点都能正确响应各种请求类型（GET, POST, PUT, DELETE等）。测试策略应包括功能测试、性能测试、安全测试和兼容性测试，以全面评估API的健壮性和可靠性。

内容

功能测试：验证API是否按预期工作，包括验证HTTP状态码、响应时间、数据格式和数据完整性。
性能测试：评估API在高负载下的表现，确保其能够处理大量请求而不会崩溃。
安全测试：检查API的安全性，包括验证、授权、数据加密和防止SQL注入等。
兼容性测试：确保API在不同的环境和条件下都能正常工作，如不同的操作系统、浏览器和设备。

示例

// 使用Postman进行API的功能测试示例// 测试一个POST请求，用于创建新用户// 设置请求
pm.request.body.addText("username","testuser");
pm.request.body.addText("password","testpassword");// 发送请求
pm.sendRequest({url:"https://api.example.com/users",method:"POST",header:"Content-Type: application/x-www-form-urlencoded",body: pm.request.body
},function(err, res){// 验证响应if(err){
        console.error(err);}else{test('Status code is 201',function(){
            pm.response.to.have.status(201);});test('Response body contains username',function(){
            pm.response.to.have.jsonBody('username','testuser');});}});

优化Postman集合以提高效率

原理

优化Postman集合可以提高测试效率，减少重复工作，确保测试的可维护性和可扩展性。这包括使用环境变量、预请求脚本和测试脚本来自动化和参数化测试。

内容

使用环境变量：允许在多个环境中轻松切换，如开发、测试和生产环境。
预请求脚本：在发送请求前执行，可以用于设置动态数据或执行预处理任务。
测试脚本：在收到响应后执行，用于验证响应是否符合预期。

示例

// 使用环境变量和预请求脚本的示例// 环境变量：baseUrl// 预请求脚本// 生成一个随机的用户IDvar randomUserId = Math.floor(Math.random()*1000);
pm.environment.set("userId", randomUserId);// 发送请求
pm.sendRequest({url: pm.environment.get("baseUrl")+"/users/"+ pm.environment.get("userId"),method:"GET"},function(err, res){// 验证响应if(err){
        console.error(err);}else{test('Status code is 200',function(){
            pm.response.to.have.status(200);});}});

与团队共享和协作Postman集合

原理

Postman集合的共享和协作可以促进团队成员之间的沟通和协作，确保所有团队成员都在使用相同的测试用例和环境设置。

内容

使用Postman团队功能：允许团队成员访问和编辑集合。
使用Postman工作空间：可以创建和管理多个工作空间，每个工作空间可以包含多个集合和环境。

集成Postman与持续集成/持续部署（CI/CD）流程

原理

将Postman集成到CI/CD流程中，可以确保每次代码更改后API的测试自动化执行，从而提高开发效率和代码质量。

内容

使用Postman Newman：一个命令行集合运行器，可以用于自动化测试。
集成到CI/CD工具：如Jenkins、Travis CI或CircleCI，可以在每次代码提交后自动运行测试。

示例

# Jenkinsfile示例，用于集成Postman测试到CI/CD流程
pipeline {
    agent any
    stages {
        stage('Run Postman Tests') {
            steps {
                sh 'newman run "https://www.getpostman.com/collections/1234567890abcdef" --environment "https://www.getpostman.com/environments/1234567890abcdef" --reporters cli,junit'
            }}}}

进阶功能

探索Postman的监控功能

监控功能概述

Postman的监控功能允许你自动化地运行一系列请求，并在预定的时间间隔内检查API的健康状况和性能。这对于确保API的稳定性和可靠性至关重要，特别是在API上线后，需要持续监控其运行状态。

如何设置监控

创建请求集合：首先，你需要在Postman中创建一个包含所有需要监控的请求的集合。
启用监控：在集合上右键，选择“监视”（Monitor），然后设置监控的频率（例如，每5分钟一次）和运行的环境。
配置监控：你可以设置监控的运行时间、运行频率、失败重试次数等参数。
查看监控结果：监控运行后，你可以在“监视”选项卡中查看详细的运行报告，包括每个请求的响应时间、状态码等信息。

示例

// 监控配置示例{"name":"API Health Check","events":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {","    pm.response.to.have.status(200);","});","pm.test(\"Response time is less than 200ms\", function () {","    pm.expect(pm.response.responseTime).to.be.below(200);","});"]}}],"request":{"url":"https://api.example.com/health","method":"GET"}}

此示例展示了如何在Postman中为API健康检查设置监控，包括基本的响应状态和响应时间测试。

利用Postman进行性能测试

性能测试的重要性

性能测试是评估API在高负载下表现的关键步骤。它帮助你了解API的响应时间、吞吐量和资源使用情况，确保API在实际使用中能够处理预期的用户量。

Postman的性能测试工具

Postman集成了Newman工具，可以用于执行性能测试。Newman是一个命令行集合运行器，可以运行Postman集合并生成详细的测试报告。

如何执行性能测试

创建性能测试集合：在Postman中创建一个包含所有测试场景的集合。
使用Newman运行集合：在命令行中使用Newman运行你的集合，可以指定运行次数和并发用户数。
分析测试结果：Newman会生成一个包含所有测试结果的报告，你可以分析这些结果来优化API性能。

示例

// 使用Newman进行性能测试的命令行示例
newman run "API Performance Test"-e"performance"-n1000-c100

此命令将运行名为“API Performance Test”的集合，使用“performance”环境，运行1000次，同时有100个并发用户。

Postman与安全测试：使用Newman进行负载测试

安全测试与负载测试

安全测试确保API不受恶意攻击，而负载测试则检查API在高并发请求下的表现。Newman可以同时用于这两种测试，通过模拟大量请求来评估API的安全性和性能。

如何进行负载测试

创建负载测试集合：在Postman中创建一个集合，包含你想要测试的所有请求。
使用Newman运行负载测试：在命令行中使用Newman运行集合，同时指定并发用户数和运行次数。
分析结果：检查Newman生成的报告，分析API的响应时间和错误率，以评估其在高负载下的表现。

示例

// 使用Newman进行负载测试的命令行示例
newman run "API Load Test"-e"load"-n5000-c200

此命令将运行名为“API Load Test”的集合，使用“load”环境，运行5000次，同时有200个并发用户。

Postman的高级数据处理与分析技巧

数据处理与分析的重要性

在API测试中，数据处理与分析是理解API行为、识别潜在问题和优化性能的关键。Postman提供了强大的数据处理功能，包括预请求脚本和测试脚本，以及数据导入和导出功能。

如何使用Postman进行数据处理

预请求脚本：在请求前运行脚本，可以动态生成请求参数，例如使用随机数或从外部数据源读取数据。
测试脚本：在请求后运行脚本，可以检查响应数据，例如验证JSON结构或提取特定值用于后续请求。
数据导入与导出：Postman支持从CSV、JSON等格式导入数据，以及将测试结果导出为各种格式，便于进一步分析。

示例

// 预请求脚本示例
pm.sendRequest({url:'https://data.example.com/users',method:'GET'},function(err, res){if(!err && res.code ===200){var data = res.json();
    pm.environment.set('user_id', data[0].id);}});

此脚本在发送请求前，先从外部数据源获取用户ID，并将其设置为环境变量，供后续请求使用。

// 测试脚本示例
pm.test("Check user data",function(){var jsonData = pm.response.json();
  pm.test("User ID matches",function(){
    pm.expect(jsonData.id).to.eql(pm.environment.get('user_id'));});});

此脚本在请求后运行，检查响应中的用户ID是否与预请求脚本中设置的环境变量相匹配。

通过上述高级功能的使用，你可以更深入地了解API的性能和安全性，确保API在各种条件下都能稳定运行。

Postman在真实项目中的应用案例

案例1: 自动化API测试

背景

在开发一个电商网站时，团队需要确保API的稳定性和性能。Postman的集合和Runner功能可以创建自动化测试，以持续监控API的健康状况。

实施步骤

创建集合: 在Postman中，为电商API创建一个集合，包含所有关键的API请求。
编写测试脚本: 使用Postman的测试脚本功能，编写检查API响应的脚本。// Postman测试脚本示例tests["Status code is 200"]= responseCode.code ===200;tests["Response time is less than 200ms"]= responseTime <200;tests["Body contains product name"]= _.includes(postman.getResponseCookie("product"),"iPhone");
运行测试: 使用Postman Runner运行测试集合，可以设置定时任务，如每天凌晨自动运行。
分析结果: 通过Runner的报告功能，分析测试结果，确保API的响应时间、状态码等符合预期。

结果

通过自动化测试，团队能够快速识别并修复API中的问题，提高了开发效率和产品质量。

案例2: 环境变量管理

背景

在多环境（如开发、测试、生产）下管理API的URL和认证信息，可以使用Postman的环境变量功能。

实施步骤

定义环境: 在Postman中创建不同的环境，如dev、test、prod。
设置变量: 在每个环境中设置URL和认证信息。// 环境变量设置示例pm.environment.set("apiUrl","https://api.example.com");pm.environment.set("token","eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9");
使用变量: 在请求中使用环境变量，确保在不同环境下的请求正确无误。// 使用环境变量的请求示例{"url":"{{apiUrl}}/products","method":"GET","header":{"Authorization":"Bearer {{token}}"}}
切换环境: 在Postman中轻松切换环境，测试API在不同环境下的表现。

结果

环境变量的使用简化了多环境下的API测试流程，避免了手动修改URL和认证信息的错误，提高了测试的准确性和效率。

案例3: 集成持续集成/持续部署(CI/CD)

背景

将Postman测试集成到CI/CD流程中，确保每次代码提交后API的测试自动化执行。

实施步骤

配置CI/CD工具: 使用如Jenkins、Travis CI等工具，配置Postman测试的执行。
触发测试: 在代码提交到仓库后，自动触发Postman测试。
测试结果通知: 将测试结果通过邮件或Slack通知团队，及时发现并解决问题。

结果

CI/CD的集成确保了API的持续测试，提高了软件的可靠性和团队的响应速度。

从错误中学习：常见的Postman使用陷阱与解决方案

陷阱1: 忽略测试脚本

问题描述

开发者可能直接发送请求而不编写测试脚本，导致无法自动验证API的正确性。

解决方案

编写测试脚本，确保API的响应符合预期。使用Postman的

tests

对象，可以检查状态码、响应时间、响应体等。

陷阱2: 环境变量未正确设置

问题描述

在不同环境中，API的URL或认证信息可能不同，如果环境变量设置错误，会导致请求失败。

解决方案

检查环境变量，确保在每个环境中都正确设置了URL和认证信息。使用

pm.environment.get()

函数来获取和验证环境变量。

陷阱3: 忽略预请求脚本

问题描述

预请求脚本可以用于在发送请求前执行一些操作，如生成随机数、设置请求头等，但经常被忽略。

解决方案

使用预请求脚本，在请求前执行必要的设置。例如，生成一个随机的用户ID。

// 预请求脚本示例var randomUserId = Math.floor(Math.random()*1000);
pm.environment.set("userId", randomUserId);

通过这些案例研究和陷阱解决方案，我们可以看到Postman在API开发和测试中的强大功能和灵活性。正确使用Postman，可以显著提高API的开发效率和质量。

标签： postman lua 测试工具

本文转载自: https://blog.csdn.net/weixin_42749425/article/details/142373476
版权归原作者 kkchenjj 所有，如有侵权，请联系我们删除。