Postman 使用教程

Postman 是一个强大的 API 开发工具,提供了简洁易用的界面来创建、测试和管理 API 请求。以下是 Postman 的基本使用方法和一些常见操作。

1. 安装 Postman

下载并安装

  1. 前往 Postman 官网,下载适用于你操作系统的 Postman 安装包。
  2. 下载完成后,按照安装向导进行安装。

2. 创建和发送请求

创建一个新的请求

  1. 打开 Postman。
  2. 点击左上角的 New 按钮,选择 HTTP Request
  3. 输入请求的 URL 和方法(GET、POST、PUT、DELETE 等)。
  4. Params 选项卡中,可以添加查询参数。
  5. Headers 选项卡中,可以添加请求头信息。
  6. Body 选项卡中,可以设置请求体(适用于 POST、PUT 等方法)。

发送请求

  1. 填写完请求信息后,点击 Send 按钮。
  2. 请求结果将显示在下方的 Response 面板中,包含响应状态码、响应头和响应体。

3. 保存请求

保存单个请求

  1. 发送请求后,点击请求名称右侧的 Save 按钮。
  2. 选择保存的位置,可以是一个新的或已有的集合(Collection)。
  3. 输入请求名称和描述,点击 Save to Collection

创建和管理集合(Collection)

  1. 点击左侧栏中的 Collections 标签。
  2. 点击 New Collection 按钮,输入集合名称和描述,点击 Create
  3. 将请求拖放到集合中,或者在集合中创建新的请求。

4. 使用环境变量

创建环境

  1. 点击右上角的 Environments 图标。
  2. 选择 Manage Environments
  3. 点击 Add,输入环境名称。
  4. 添加变量名和值,点击 Add

使用环境变量

  1. 在请求的 URL、参数、头信息或请求体中使用双花括号包围变量名,例如 {{base_url}}
  2. 选择右上角的环境,Postman 会自动替换变量值。

5. 编写测试脚本

在请求中添加测试脚本

  1. 在请求面板中,点击 Tests 选项卡。
  2. 使用 JavaScript 编写测试脚本,例如检查响应状态码:
    1
    2
    3
    pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
    });
  3. 发送请求后,测试结果将显示在 Test Results 面板中。

使用预请求脚本

  1. 在请求面板中,点击 Pre-request Script 选项卡。
  2. 编写 JavaScript 代码,设置请求前需要执行的操作,例如生成时间戳或计算签名。

6. 运行集合

使用 Collection Runner

  1. 打开左侧栏中的 Collections 标签。
  2. 选择一个集合,点击集合名称右侧的 Run 按钮。
  3. Collection Runner 界面,选择环境和迭代次数,点击 Start Run
  4. 运行结果将显示在下方,包括每个请求的详细信息和测试结果。

7. 自动化测试与 CI/CD 集成

Postman 提供了 Newman,一个命令行工具,可以用于自动化测试和与 CI/CD 流程集成。

安装 Newman

  1. 确保已安装 Node.js。
  2. 在终端中运行以下命令安装 Newman:
    1
    npm install -g newman

使用 Newman 运行集合

  1. 将 Postman 集合导出为 JSON 文件。
  2. 在终端中运行以下命令,使用 Newman 运行集合:
    1
    newman run /path/to/collection.json -e /path/to/environment.json

结论

Postman 是一个功能强大的 API 开发和测试工具,通过简单直观的界面和丰富的功能,帮助开发者轻松创建、测试和管理 API 请求。通过学习和掌握以上基本操作,可以大大提高 API 开发和测试的效率。如果需要更高级的功能,还可以进一步探索 Postman 的自动化测试和 CI/CD 集成能力。