软件工程

Postman入门指南:新手必看教程

本文主要是介绍Postman入门指南:新手必看教程,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
概述

Postman是一款强大的API测试工具,支持多种请求方法和格式,帮助开发人员轻松测试和调试API。文章详细介绍了Postman的安装方法、基本使用和高级功能,包括环境变量设置和协作开发。

Postman简介与安装
Postman是什么

Postman 是一款强大的工具,主要用于测试API接口和进行Web服务的调试。它支持多种请求方法和格式,并可以轻松地查看响应数据。Postman可以帮助开发人员和测试人员轻松地测试和调试API,同时也能帮助产品经理了解API的设计和实现情况。此外,Postman还提供了一系列协作功能,方便团队成员共享测试用例和文档。

Postman支持Windows、Mac、Linux和Chrome浏览器,能够满足不同操作系统用户的需要。

Postman的安装步骤

Windows系统安装步骤

  1. 访问官网下载页面,选择Windows系统版下载安装包。
  2. 运行下载的安装程序,按照向导提示完成安装。
  3. 安装完成后,打开Postman,点击右上角的“Skip教程”以跳过教程。
  4. 跳过欢迎界面,点击右上角的“Create an account”进行账号注册。
  5. 注册完成后,使用刚刚注册的账号登录并开始使用Postman。

Mac系统安装步骤

  1. 访问官网下载页面,选择Mac系统版下载安装包。
  2. 运行下载的安装程序,按照向导提示完成安装。
  3. 安装完成后,打开Postman,点击右上角的“Skip教程”以跳过教程。
  4. 跳过欢迎界面,点击右上角的“Create an account”进行账号注册。
  5. 注册完成后,使用刚刚注册的账号登录并开始使用Postman。

Linux系统安装步骤

  1. 访问官网下载页面,选择Linux系统版下载安装包。
  2. 运行下载的安装程序,按照向导提示完成安装。
  3. 安装完成后,打开Postman,点击右上角的“Skip教程”以跳过教程。
  4. 跳过欢迎界面,点击右上角的“Create an account”进行账号注册。
  5. 注册完成后,使用刚刚注册的账号登录并开始使用Postman。

Chrome浏览器插件安装步骤

  1. 访问Chrome网上应用商店搜索Postman。
  2. 点击“添加到Chrome”按钮,安装插件。
  3. 安装完成后,打开Postman,点击右上角的“Skip教程”以跳过教程。
  4. 跳过欢迎界面,点击右上角的“Create an account”进行账号注册。
  5. 注册完成后,使用刚刚注册的账号登录并开始使用Postman。
创建第一个Postman账号
  1. 打开Postman并点击右上角的“Create an account”。
  2. 输入邮箱地址,并选择一个密码。
  3. 通过邮箱地址接收激活邮件,点击邮件中的链接以激活账号。
  4. 使用邮箱地址和密码登录Postman,开始使用。

快速上手Postman
Postman界面介绍

启动Postman后,可以看到主界面中主要分为以下几个部分:

  • 左侧的请求列表区:这是Postman最重要的部分,所有的请求都会在此显示,可以通过搜索框快速查找请求。
  • 中间的请求区:在这里可以输入请求的URL、选择请求类型(例如GET、POST等)、设置请求头、发送请求并查看响应数据。
  • 右侧的环境变量区:用于设置和管理Postman的环境变量。
  • 底部的监听器区:用于查看详细的请求和响应数据,包括时间、状态码、响应头等信息。
如何创建请求
  1. 在左侧的请求列表区,点击“+”按钮新建请求。
  2. 输入请求名称,例如“Create User”。
  3. 选择请求类型,例如“POST”。
  4. 在请求URL框中输入请求的URL,例如http://jsonplaceholder.typicode.com/users
  5. 在请求体区域中输入请求数据,例如:

    {
     "name": "John Doe",
     "username": "johndoe",
     "email": "johndoe@example.com",
     "address": {
       "street": "21 Jump Street",
       "suite": "Apt. 302",
       "city": "New York",
       "zipcode": "10001"
     },
     "phone": "123-456-7890",
     "website": "johndoe.com",
     "company": {
       "name": "Acme Inc.",
       "catchPhrase": "Making the world a better place",
       "bs": "Innovative solutions"
     }
    }
  6. 点击右侧的“Send”按钮发送请求。
常用请求方法(GET, POST)

GET请求

  1. 在请求列表区新建请求,命名为“GET Users”。
  2. 选择请求类型为“GET”。
  3. 输入请求URL,例如http://jsonplaceholder.typicode.com/users
  4. 点击“Send”按钮发送请求,查看响应数据。

POST请求

  1. 在请求列表区新建请求,命名为“Create User”。
  2. 选择请求类型为“POST”。
  3. 输入请求URL,例如http://jsonplaceholder.typicode.com/users
  4. 在请求体区域中输入请求数据,例如:

    {
     "name": "Jane Doe",
     "username": "janedoe",
     "email": "janedoe@example.com",
     "address": {
       "street": "123 Main Street",
       "suite": "Apt. 401",
       "city": "Los Angeles",
       "zipcode": "90001"
     },
     "phone": "098-765-4321",
     "website": "janedoe.com",
     "company": {
       "name": "Bazooka Corp.",
       "catchPhrase": "Innovative technology",
       "bs": "Disruptive solutions"
     }
    }
  5. 点击“Send”按钮发送请求,查看响应数据。

使用Postman进行API测试
如何添加环境变量
  1. 在左侧的请求列表区,点击“Add”按钮新建环境。
  2. 输入环境名称,例如“Development”。
  3. 在环境变量中添加变量,例如:

    • baseURL: http://jsonplaceholder.typicode.com
    • userId: 12345
  4. 点击“Save”按钮保存环境。
pm.environment.set("baseURL", "http://jsonplaceholder.typicode.com");
pm.environment.set("userId", 12345);
测试API响应
  1. 在请求列表区新建请求,命名为“Get User”。
  2. 选择请求类型为“GET”。
  3. 在请求URL中使用环境变量,例如:

    • {{baseURL}}/users/{{userId}}
  4. 点击“Send”按钮发送请求。
  5. 在响应区查看返回的数据,确认返回的数据是否满足预期。
{
  "userId": "{{userId}}",
  "title": "User {{userId}} details"
}
保存与运行测试脚本
  1. 在请求列表区新建请求,命名为“Check User”。
  2. 选择请求类型为“GET”。
  3. 在请求URL中使用环境变量,例如:

    • {{baseURL}}/users/{{userId}}
  4. 在测试脚本区输入脚本,例如:

    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);
    });
    
    pm.test("User ID matches", function() {
     var jsonData = pm.response.json();
     pm.expect(jsonData.id).to.be.equal(pm.environment.get("userId"));
    });
  5. 点击“Send”按钮发送请求。
  6. 在测试脚本区查看测试结果,确认所有测试都通过。
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);
});

pm.test("User ID matches", function() {
  var jsonData = pm.response.json();
  pm.expect(jsonData.id).to.be.equal(pm.environment.get("userId"));
});

Postman高级功能介绍
使用Postman文件夹组织请求
  1. 在左侧的请求列表区,点击“Add”按钮新建文件夹。
  2. 输入文件夹名称,例如“My API Requests”。
  3. 将创建的请求拖动到该文件夹中。
  4. 可以继续创建子文件夹,例如“User Requests”、“Product Requests”等,以进一步细化请求组织方式。
利用Postman监听器查看响应详情
  1. 在请求列表区选择一个请求,例如“Get User”。
  2. 选择监听器选项卡。
  3. 在监听器选项卡中,可以查看请求和响应的所有数据,包括时间、状态码、响应头、响应体等。
  4. 可以使用“Pause Before Sending”按钮暂停请求发送,以便进行调试。

示例代码

pm.test("User ID matches", function() {
  var jsonData = pm.response.json();
  pm.expect(jsonData.id).to.be.equal(pm.environment.get("userId"));
});
脚本编写基础

Pre-request脚本

  1. 在请求列表区选择一个请求,例如“Create User”。
  2. 选择“Pre-request Script”标签。
  3. 在脚本区输入脚本,例如:

    pm.environment.set("userId", pm.environment.get("userId") + 1);
  4. 运行请求,查看环境变量是否被正确设置。

Test脚本

  1. 在请求列表区选择一个请求,例如“Get User”。
  2. 选择“Tests”标签。
  3. 在脚本区输入脚本,例如:

    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);
    });
    
    pm.test("User ID matches", function() {
     var jsonData = pm.response.json();
     pm.expect(jsonData.id).to.be.equal(pm.environment.get("userId"));
    });
  4. 运行请求,查看测试结果是否通过。

示例代码

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);
});

pm.test("User ID matches", function() {
  var jsonData = pm.response.json();
  pm.expect(jsonData.id).to.be.equal(pm.environment.get("userId"));
});

使用Postman进行协作开发
如何分享和协作
  1. 在左侧的请求列表区,选择要分享的请求,例如“Get User”。
  2. 点击选项菜单,选择“Collaboration”。
  3. 在“Collaboration”面板中,输入团队成员的邮箱地址,点击“Add”按钮邀请他们加入协作。
  4. 团队成员接受邀请后,可以在Postman中看到该请求,并进行编辑、测试等操作。
使用Postman工作空间
  1. 在左侧的请求列表区,点击“Add”按钮新建工作空间。
  2. 输入工作空间名称,例如“Project XYZ”。
  3. 选择团队成员,点击“Create”按钮创建工作空间。
  4. 将请求拖动到工作空间中,进行协作开发。
API文档的生成
  1. 在左侧的请求列表区,选择要生成文档的请求,例如“Get User”。
  2. 在请求详情页面中,点击“Documentation”标签。
  3. 在文档区输入描述,例如:“This endpoint retrieves a user by ID.”。
  4. 保存文档,团队成员可以在工作空间中查看该文档。
# Get User

This endpoint retrieves a user by ID.

### Request

- **URL:** `/users/{userId}`
- **Method:** GET
- **Parameters:**
  - `userId` (path): User ID

### Response

- **Success Response:**
- **Code:** 200 OK
- **Body:**

{
"id": 12345,
"name": "John Doe",
"email": "johndoe@example.com",
"address": {
"street": "21 Jump Street",
"suite": "Apt. 302",
"city": "New York",
"zipcode": "10001"
},
"phone": "123-456-7890",
"website": "johndoe.com"
}

- **Error Response:**
- **Code:** 404 Not Found
- **Body:**

{
"error": "User not found"
}



Postman常见问题解决
常见错误及解决方案

404 Not Found

  • 问题描述: 发送请求时返回404错误,表示请求的资源不存在。
  • 解决方案: 检查请求的URL是否正确,确认资源是否存在。

500 Internal Server Error

  • 问题描述: 发送请求时返回500错误,表示服务器发生内部错误。
  • 解决方案: 检查请求的参数是否正确,确认服务器端的代码是否存在问题。

请求超时

  • 问题描述: 发送请求时返回超时错误,表示请求时间过长。
  • 解决方案: 检查服务器是否响应缓慢,确认是否需要增加超时时间。

无法连接到服务器

  • 问题描述: 发送请求时返回无法连接到服务器的错误。
  • 解决方案: 检查网络连接是否正常,确认服务器地址是否正确。
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);
});

pm.test("User ID matches", function() {
  var jsonData = pm.response.json();
  pm.expect(jsonData.id).to.be.equal(pm.environment.get("userId"));
});
如何提高Postman使用效率
  1. 使用快捷键:例如Ctrl+Enter发送请求,Ctrl+Shift+P打开命令面板。
  2. 使用命令面板:通过命令面板快速执行常用操作,例如新建请求、添加环境等。
  3. 使用第三方插件:例如Newman、Mergin等插件,可以扩展Postman的功能。
  4. 学习并使用Postman的API:通过Postman的API进行自动化操作,例如创建请求、发送请求等。
推荐阅读及资源链接
  • Postman官方文档:https://learning.postman.com/
  • Postman官方博客:https://www.postman.com/blog/
  • Postman官方GitHub:https://github.com/postmanlabs
  • Postman官方论坛:https://www.postman.com/forums/
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);
});

pm.test("User ID matches", function() {
  var jsonData = pm.response.json();
  pm.expect(jsonData.id).to.be.equal(pm.environment.get("userId"));
});

通过以上内容,你已经掌握了Postman的基本操作和一些高级功能,能够使用Postman进行API测试和协作开发。希望这篇文章对你有所帮助,祝你在API测试和开发工作中取得成功!

这篇关于Postman入门指南:新手必看教程的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!