0
0

Postman：Postman脚本编写、团队协作与文档分享教程

Postman：Postman脚本编写、团队协作与文档分享教程

在这里插入图片描述

Postman基础介绍

Postman的安装与配置

在开始使用Postman之前，首先需要安装Postman应用。Postman支持多种操作系统，包括Windows、macOS和Linux。访问Postman官方网站(https://www.postman.com/downloads/)，选择适合您操作系统的版本进行下载。

安装过程简单直观，只需按照屏幕上的提示操作即可。安装完成后，启动Postman，您将被要求登录或创建一个Postman账户。登录后，Postman会同步您的数据，包括请求、集合、环境等，确保在不同设备间的一致性。

配置环境

Postman允许您设置不同的环境，这对于在开发、测试和生产环境中切换非常有用。要创建新环境，点击顶部菜单的“Manage Environments”，然后点击“Add”按钮。输入环境名称，例如“Development”，然后添加变量，如

base_url

，并设置其值为开发服务器的URL。

// 示例：在Postman中设置环境变量
pm.environment.set("base_url","https://dev.example.com");

配置请求

在Postman中发送HTTP请求非常简单。点击左上角的“New”按钮，选择“Request”。在新打开的窗口中，输入请求的URL，选择请求方法（GET、POST、PUT等），并可以添加请求头、参数和Body。

// 示例：使用Postman发送POST请求
pm.sendRequest({url: pm.environment.get("base_url")+"/api/data",method:"POST",header:{"Content-Type":"application/json"},body:JSON.stringify({"name":"John Doe","email":"[email protected]"})},function(err, res){if(err){
    console.error(err);}else{
    console.log(res);}});

Postman界面解析

Postman的界面设计直观，旨在简化API测试和开发流程。以下是界面的主要组成部分：

  1. 请求方法选择器：位于界面顶部，用于选择HTTP请求方法。
  2. URL输入框：紧随请求方法选择器，用于输入请求的URL。
  3. 请求头编辑器：用于添加或编辑请求头信息。
  4. 参数编辑器：用于添加URL参数。
  5. Body编辑器：用于构建请求体，支持多种格式，如JSON、XML、表单数据等。
  6. 预请求脚本编辑器：允许在发送请求前执行JavaScript脚本。
  7. 测试脚本编辑器：用于编写测试脚本，验证API响应。
  8. 发送按钮：发送构建好的请求。
  9. 响应查看器：显示API的响应结果。
  10. 集合管理器：用于组织和管理请求集合。
  11. 环境变量管理器：管理不同环境下的变量。
  12. 监控器：查看请求的性能和状态。
  13. 新标签页：创建新的请求或集合。
  14. 历史记录：查看和重放之前的请求。
  15. 导入和导出：导入或导出请求、集合和环境。

集合管理

集合是Postman中组织请求的一种方式。点击左侧的“Collections”标签，可以看到已有的集合列表。点击“New Collection”可以创建一个新的集合，然后将相关的请求拖放到该集合中。

// 示例：在Postman中创建集合
pm.collection.addRequest("Get User");
pm.collection.addRequest("Create User");

环境变量使用

环境变量在Postman中用于存储和管理API测试中常用的变量，如URL、API密钥等。在请求中，可以使用双大括号

{{variable_name}}

来引用环境变量。

// 示例：在请求中使用环境变量
pm.sendRequest({url:"{{base_url}}/api/data",method:"GET"},function(err, res){if(err){
    console.error(err);}else{
    console.log(res);}});

测试脚本编写

Postman内置了测试脚本功能，允许您在请求发送后自动执行测试。测试脚本使用Postman的专用测试API，可以检查响应状态、响应时间、响应体中的数据等。

// 示例：编写测试脚本检查响应状态
tests["Status code is 200"]= responseCode.code ===200;// 示例：检查响应体中是否存在特定数据
tests["Response has data"]= responseBody.has("data");

文档分享

Postman不仅是一个强大的API测试工具，还提供了文档分享功能，便于团队成员之间的协作。点击“Share”按钮，可以选择分享方式，如生成公共链接、导出为JSON或HTML文档，或直接在Postman中分享给其他用户。

// 示例：导出Postman集合为JSON
pm.exportData(function(data){
  console.log(JSON.stringify(data));});

通过以上介绍，您应该对Postman的基本使用和界面有了初步了解。Postman的强大功能远不止于此，随着您深入使用，会发现更多高级特性和技巧。

Postman脚本编写

Pre-request脚本编写

在Postman中，Pre-request脚本是在发送请求之前运行的脚本，主要用于设置请求的动态部分，如生成随机数、修改请求头或请求体等。这在测试需要动态参数的API时非常有用。

示例：生成随机数并添加到请求体

// 生成一个随机数var randomNum = Math.floor(Math.random()*1000)+1;// 将随机数添加到请求体中
pm.request.body.update({mode:'raw',raw:JSON.stringify({"id": randomNum,"name":"测试用户"}),options:{raw:{language:'json'}}});

解释:

  • Math.floor(Math.random() * 1000) + 1 生成一个1到1000之间的随机整数。
  • pm.request.body.update 方法用于更新请求体，这里将生成的随机数randomNum添加到请求体的id字段中。

Tests脚本编写

Tests脚本在Postman中用于验证API响应是否符合预期，可以检查状态码、响应时间、响应体中的数据等。

示例：检查响应状态码和响应时间

// 检查响应状态码是否为200
pm.test("状态码检查",function(){
    pm.response.to.have.status(200);});// 检查响应时间是否小于200ms
pm.test("响应时间检查",function(){
    pm.expect(pm.response.responseTime).to.be.below(200);});

解释:

  • pm.test 方法用于定义测试用例，第一个参数是测试用例的名称，第二个参数是一个函数，函数内部定义了具体的测试逻辑。
  • pm.response.to.have.status(200) 检查响应状态码是否为200。
  • pm.expect(pm.response.responseTime).to.be.below(200) 检查响应时间是否小于200ms。

使用JavaScript进行动态脚本编写

Postman的脚本编写支持使用JavaScript，这使得脚本具有高度的灵活性和动态性，可以处理复杂的测试场景。

示例：动态修改请求头

// 动态设置请求头中的Authorization字段var token ="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";// 假设这是一个JWT token
pm.request.headers.upsert({key:'Authorization',value:'Bearer '+ token});

解释:

  • pm.request.headers.upsert 方法用于更新或插入请求头字段，这里将JWT token添加到Authorization字段中，格式为Bearer token。

示例：动态生成请求参数

// 动态生成请求参数var timestamp =newDate().getTime();var params ={"timestamp": timestamp,"action":"create"};
pm.request.url.query.all().forEach(function(param){
    pm.request.url.query.remove(param);});
pm.request.url.query.add(params);

解释:

  • new Date().getTime() 生成当前时间的Unix时间戳。
  • pm.request.url.query.all().forEach(function(param) { pm.request.url.query.remove(param); }) 清除所有现有的查询参数。
  • pm.request.url.query.add(params) 添加动态生成的查询参数。

通过这些示例，我们可以看到Postman脚本编写如何利用JavaScript的动态特性来增强API测试的灵活性和效率。

Postman团队协作与文档分享教程

团队协作功能

创建与管理团队

在Postman中，创建团队是实现协作的第一步。团队的创建允许你将Postman的使用扩展到多个用户，促进项目共享和协作。

创建团队
  1. 登录你的Postman账户。
  2. 点击左上角的Teams选项。
  3. 选择Create Team，输入团队名称和描述。
  4. 确定团队的可见性：公开或私有。
  5. 点击Create Team完成创建。
管理团队
  • 添加成员：在团队页面，点击Add Members，输入成员的Postman用户名或电子邮件地址。
  • 设置角色：成员可以被赋予不同角色，如Admin、Member或Guest，每种角色有不同的权限。
  • 移除成员：在团队成员列表中，选择成员，点击Remove。

共享集合与环境

Postman集合和环境的共享是团队协作的关键。集合包含一系列API请求，环境则存储请求的变量和配置。

共享集合
  1. 打开你想要共享的集合。
  2. 点击Share按钮。
  3. 选择Share with Team。
  4. 选择你的团队，设置访问权限。
  5. 点击Share。
共享环境
  1. 在Postman中，打开Manage Environments。
  2. 选择你想要共享的环境，点击Share。
  3. 选择你的团队，设置访问权限。
  4. 点击Share。

协作中的权限设置

Postman的权限设置确保了团队成员可以按照其角色和职责访问特定的资源。

权限类型
  • Admin：可以管理团队，包括添加和移除成员，设置权限。
  • Member：可以访问和编辑团队共享的集合和环境。
  • Guest：只能查看团队共享的集合和环境，不能编辑。
设置权限
  1. 在团队页面，选择Manage Permissions。
  2. 为每个成员选择合适的角色。
  3. 对于特定集合或环境，可以进一步细化权限，如只读或可编辑。
  4. 点击Save应用权限设置。

示例：共享集合

假设你有一个名为

MyAPI

的集合，想要与你的团队共享。以下是如何在Postman中实现这一过程的步骤：

1. 打开`MyAPI`集合。
2. 点击右上角的`Share`按钮。
3. 在弹出的窗口中，选择`Share with Team`。
4. 从下拉菜单中选择你的团队`MyTeam`。
5. 设置访问权限为`Edit`，允许团队成员编辑集合。
6. 点击`Share`完成共享。

示例代码：使用Postman API共享集合

// 使用Postman API共享集合的示例代码const axios =require('axios');// Postman API的URLconst postmanApiUrl ='https://api.getpostman.com';// 你的Postman API密钥const apiKey ='your_api_key_here';// 要共享的集合IDconst collectionId ='your_collection_id_here';// 团队IDconst teamId ='your_team_id_here';// 设置请求头const headers ={'X-Api-Key': apiKey,'Content-Type':'application/json'};// 设置请求体const data ={"team": teamId,"access":"edit"};// 发送POST请求共享集合
axios.post(`${postmanApiUrl}/collections/${collectionId}/share`, data,{ headers }).then(response=>{
    console.log('集合共享成功:', response.data);}).catch(error=>{
    console.error('集合共享失败:', error);});

这段代码使用了

axios

库来调用Postman API，将

MyAPI

集合共享给

MyTeam

团队，并设置为可编辑权限。

结论

通过上述步骤和示例，你可以在Postman中有效地创建和管理团队，共享集合与环境，并设置协作中的权限。这将极大地提升团队在API开发和测试过程中的效率和协作性。

文档分享与管理

生成API文档

在Postman中，生成API文档是一个关键功能，它帮助团队成员理解API的结构和功能，促进团队协作。Postman允许你以多种格式导出API文档，包括Markdown、HTML、Word等，这使得文档可以轻松地在不同的平台和团队成员之间共享。

如何生成API文档

  1. 打开你的Postman应用。
  2. 选择你想要生成文档的集合。
  3. 点击集合，然后在右侧的面板中选择“Documentation”选项。
  4. 在“Documentation”页面中，你可以看到Postman自动生成的API文档预览。
  5. 若要导出文档，点击页面顶部的“Export”按钮，选择你偏好的格式，然后保存到你的本地机器或云存储中。

导出与导入集合

导出和导入集合是Postman中用于备份和分享API测试的重要功能。这使得团队成员可以轻松地共享他们的测试工作，无论是在本地还是在远程工作环境中。

导出集合

  1. 在Postman中，打开你想要导出的集合。
  2. 点击集合名称旁边的三个点，选择“Export”。
  3. 选择你想要的导出格式（JSON或Collection v2.1），然后点击“Export”按钮。
  4. 保存导出的文件到你的本地机器。

导入集合

  1. 打开Postman应用。
  2. 点击左侧菜单中的“Import”按钮。
  3. 选择“File”，然后从你的本地机器中选择你之前导出的集合文件。
  4. 点击“Import”按钮，Postman将导入并创建一个新的集合。

示例：导出集合为JSON格式

// 导出的集合示例{"info":{"name":"Example Collection","description":"A collection of API tests for demonstration purposes.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Get User","request":{"method":"GET","header":[],"url":{"raw":"https://api.example.com/users/1","protocol":"https","host":["api.example.com"],"path":["users","1"]}},"response":[]},{"name":"Create User","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"John Doe\",\n  \"email\": \"[email protected]\"\n}"},"url":{"raw":"https://api.example.com/users","protocol":"https","host":["api.example.com"],"path":["users"]}},"response":[]}]}

解释

上述JSON代码示例展示了如何导出一个包含两个API请求的集合：一个GET请求用于获取用户信息，一个POST请求用于创建新用户。每个请求都详细描述了其方法、URL、请求头和请求体，这使得其他团队成员可以清楚地理解每个API的功能和使用方式。

使用Postman公共工作空间分享文档

Postman的公共工作空间功能允许你将API文档和集合分享给团队以外的人员，这在进行外部协作或向客户展示API时非常有用。

如何使用公共工作空间分享文档

  1. 在Postman中，打开你想要分享的集合或文档。
  2. 点击“Share”按钮。
  3. 选择“Public Workspace”选项。
  4. 你可以选择创建一个新的公共工作空间或选择一个现有的工作空间。
  5. 点击“Share”按钮，Postman将生成一个公共链接，你可以通过电子邮件、社交媒体或任何其他方式分享这个链接。

示例：创建并分享公共工作空间

假设你已经创建了一个名为“Example Collection”的集合，并想要将其分享给一个外部团队。你可以在Postman中按照以下步骤操作：

  1. 打开“Example Collection”。
  2. 点击“Share”按钮。
  3. 选择“Public Workspace”。
  4. 输入描述，选择权限（如“View Only”），然后点击“Create”或“Share”按钮。
  5. Postman将生成一个公共链接，你可以复制并分享给外部团队。

通过使用Postman的文档分享与管理功能，团队可以更有效地协作，确保所有成员都对API有清晰的理解，同时也能方便地与外部团队或客户进行沟通。

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

“Postman：Postman脚本编写、团队协作与文档分享教程”的评论:

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

探索数据，洞见未来——第二届大数据与数据挖掘国际会议（BDDM 2024）诚邀参会投稿！

[RabbitMQ] 重试机制+TTL+死信队列

前端部署项目到服务器（宝塔面板·腾讯云专享版），vue项目为例

猫头虎 分享：免费使用Claude 3.5 的AI代码编辑器 Windsurf Editor，全面解析！

【Python】【持续项目】Python-安全项目搜集

泷羽sec学习day5-安全见闻6

随身 WiFi 通过 USB 连接路由器共享网络 扩展网络覆盖范围

文章导航