Postman 是一个流行的 API 测试工具,用于开发人员和测试人员测试和调试 API。它提供了丰富的功能,包括发送请求、查看响应、自动化测试、环境变量管理等。以下是关于 Postman 详细使用的介绍:
1. 安装 Postman
在 Windows / Mac / Linux 上安装
- 访问 Postman 官网。
- 下载适合您操作系统的安装程序。
- 运行安装程序并按照提示完成安装。
2. 界面介绍
- Workspace:Postman 的工作区域,可以包含多个集合、环境等。
- Collections:组织和管理 API 请求的集合,可以包含多个请求。
- Environments:管理不同环境的变量,例如开发、测试和生产环境。
- Request Builder:构建和发送 HTTP 请求的界面。
- Response Viewer:查看和分析 API 响应的界面。
3. 创建和发送请求
基本请求
- 打开 Postman,点击
New
按钮。 - 选择
HTTP Request
。 - 在请求构建器中输入请求 URL。
- 选择请求方法(GET、POST、PUT、DELETE 等)。
- 点击
Send
按钮发送请求。
设置请求头
- 在请求构建器中,点击
Headers
选项卡。 - 添加请求头的键和值。
设置请求体
- 在请求构建器中,点击
Body
选项卡。 - 选择请求体类型(例如
form-data
、x-www-form-urlencoded
、raw
、binary
)。 - 输入请求体数据。
4. 查看响应
- 请求发送成功后,响应数据会显示在响应查看器中。
- 可以查看响应状态码、响应时间、响应体等信息。
- 点击
Headers
选项卡可以查看响应头。
5. 使用集合(Collections)
创建集合
- 在左侧栏中点击
New Collection
按钮。 - 输入集合名称和描述。
- 点击
Create
按钮。
添加请求到集合
- 在请求构建器中,点击
Save
按钮。 - 选择保存到已有集合或新建集合。
- 输入请求名称和描述,点击
Save
。
6. 环境和变量
创建环境
- 在右上角的
Environment
下拉菜单中选择Manage Environments
。 - 点击
Add
按钮,输入环境名称。 - 添加环境变量(键和值),点击
Add
按钮。
使用环境变量
- 在请求 URL 或请求头、请求体中使用环境变量,格式为
{{variable_name}}
。 - 选择对应的环境,然后发送请求。
7. 测试和断言
编写测试
- 在请求构建器中,点击
Tests
选项卡。 - 使用 JavaScript 编写测试脚本,例如检查响应状态码、响应体等。
-
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); });
发送请求,查看测试结果。 8. 自动化测试运行集
在集合上点击右键,选择
Run
。
配置运行选项,例如迭代次数、延迟时间等。
点击 Run
按钮,查看运行结果。
安装 Newman:
集成 CI/CD
Postman 提供了 Newman,一个命令行工具,用于在 CI/CD 管道中运行集合。以下是使用 Newman 的示例:
- 安装 Newman:
-
npm install -g newman
使用 Newman 运行集合:
API 文档生成
通过以上步骤,您可以全面掌握 Postman 的基本和高级功能。Postman 的灵活性和强大功能使其成为开发和测试 API 的利器。如果需要更多详细信息,请参考 Postman 官方文档。
-
newman run <collection_file.json> -e <environment_file.json>
10. 高级功能
Mock Server
- 在 Postman 中创建一个新的 Mock Server。
- 配置模拟响应,方便在没有实际 API 时进行开发和测试。
- 在集合上点击右键,选择
Publish Docs
。 - PostMan中文文档
- Jenkins 用户手册