postman介绍、安装、使用、功能特点、注意事项

摘要:Postman = GUI 版 CURL + 自动化测试 + 文档生成器。
安装后 3 分钟可发出第一条请求;10 分钟写出第一个断言;30 分钟生成可发布的 API 文档。支持环境变量、CI 集成、Mock Server,是前后端协作效率倍增器。

Postman是一款流行的API开发工具,它提供了丰富的功能,包括创建、测试、调试和文档化API。本文将介绍Postman的安装、使用方法,以及其功能特点和注意事项。

1. 介绍

Postman是一款用于构建、测试和调试API的工具,它提供了用户友好的界面和丰富的功能,使得开发者可以更轻松地处理API相关的任务。Postman最初是一个Chrome浏览器插件,后来发展成为一个独立的桌面应用程序,并且支持Windows、Mac和Linux平台。

2. 安装

你可以从Postman官方网站(https://www.postman.com/)下载适用于你操作系统的安装程序,然后按照提示进行安装即可。安装完成后,你可以登录你的Postman账号或者创建一个新账号,以便同步你的API集合和环境变量。

3. 使用

3.1 创建请求

打开Postman后,你可以通过点击左上角的加号按钮来创建一个新的请求。在弹出的对话框中,你需要填写请求的URL、HTTP方法、请求头、请求体等信息。

3.2 发送请求

填写完请求信息后,你可以点击“发送”按钮来发送请求。Postman会向指定的URL发送HTTP请求,并显示服务器的响应结果。

3.3 测试与调试

在收到服务器的响应后,你可以在Postman中进行测试和调试。你可以使用预置的测试脚本来验证服务器的响应是否符合预期,并通过调试功能来排查问题。

3.4 管理环境变量

Postman允许你创建多个环境,并在环境中定义全局变量和环境变量。这些变量可以在请求中引用,从而使得请求参数更加灵活和可配置。

3.5 文档化API

除了发送请求和测试响应外,Postman还可以帮助你文档化API。你可以将请求保存为集合,并添加注释和说明,最终生成API文档以供他人查阅。

Postman 是一个流行的 API 测试工具,但它本身不提供直接的文档生成功能。不过,你可以使用 Postman 的集合(Collections)功能来组织你的 API 请求,并导出为文件,以便生成 API 文档。

以下是使用 Postman 导出 API 文档的步骤:

  1. 在 Postman 中创建集合并添加你的请求。

  2. 一旦你的集合准备好了,你可以选择导出为 v2.1 格式的集合 JSON 文件。

  3. 使用第三方工具或服务,如 APIary、Swagger UI 或 Slather 来生成 API 文档。

例如,你可以使用以下命令行工具 Slather 将 Postman 集合 JSON 转换为 API Blueprint 格式的文档:

slather --input-format=json --output-format=markdown --input-path=YourCollection.postman_collection.json --output-path=API_DOCUMENTATION.md

确保你已经安装了 Slather,并根据你的 Postman 集合文件的实际路径和名称来调整上述命令中的参数。

这样,你就可以将 Postman 集合转换为可读的 API 文档。你还可以使用其他类似的工具,如 Dredd 和 Apiary CLI 来自动化 API 文档的生成。

3.6 三个必敲代码案例

1.最简 GET(带查询串)
GET https://httpbin.org/get?name=postman
Tests 标签页写:

pm.test("状态码 200", () => pm.response.to.have.status(200));
pm.test("返回 name 正确", () => {
    const json = pm.response.json();
    pm.expect(json.args.name).to.eql("postman");
});

→ 点击 Send → Test Results 全绿即通过。

2.POST JSON + 环境变量
① 新建 Environment「Dev」,加变量 baseUrl = https://httpbin.org
② 请求:

POST {{baseUrl}}/post
Content-Type: application/json

{
  "user": "chen",
  "pwd": "{{pwd}}"   // 变量在环境中维护,避免硬编码
}

Tests:

pm.test("响应时间 < 500ms", () => {
    pm.expect(pm.response.responseTime).to.be.below(500);
});

→ 切换环境即可一键换线上/测试地址。

3.自动化流水线(CLI + 报告)
安装 Newman:npm i -g newman
导出集合「demo-collection.json」和环境「demo-env.json」
命令行:

newman run demo-collection.json -e demo-env.json \
  --reporters cli,html --reporter-html-export report.html

→ 双击 report.html 即可看到图文版测试报告,可嵌入 Jenkins/GitHub Actions。

4. 功能特点

  • 用户友好的界面:Postman提供直观、易用的用户界面,使得开发者可以快速上手。
  • 多种HTTP方法支持:Postman支持常见的HTTP方法,包括GET、POST、PUT、DELETE等。
  • 丰富的请求编辑功能:Postman提供了丰富的请求编辑功能,包括请求头、请求体、参数等。
  • 强大的测试与调试功能:Postman支持编写测试脚本,可以自动验证服务器的响应结果,并提供了调试功能用于排查问题。
  • 环境变量管理:Postman允许创建多个环境,并在环境中定义全局变量和环境变量,使得请求参数更加灵活和可配置。
  • API文档化:Postman可以帮助你将请求保存为集合,并生成API文档以供他人查阅。

5. 注意事项

  • 合理使用Postman账号:如果你使用Postman账号登录,务必注意账号的安全性,避免泄露重要信息。
  • 谨慎保存敏感信息:在Postman中创建请求时,避免将敏感信息(如密码、密钥等)保存在请求中,以免泄露。
  • 遵守服务器规定:在使用Postman测试API时,务必遵守服务器的规定,避免造成不必要的麻烦或损失。
  • 及时更新软件版本:定期更新Postman的软件版本,以获取最新的功能和安全补丁,提高软件的稳定性和安全性。

6. 文章总结

  1. 60 秒界面速览 打开软件后,记住“左中右”三栏: 左侧 Sidebar:Collections / APIs / Environments / Mock Servers / Monitors 中间 Builder:地址栏 + 请求方法 + 请求体 + 测试脚本 右侧:响应区(Body/Cookies/Headers/Test Results) 思维导图(高清 PNG 已放阿里云盘,链接见文末)挂在工位,5 天就能背下来。

  2. 安装与避坑 Win:务必勾选“Add to PATH”,后续 Newman 会用到。 Mac:M1/M2 芯片直接下载 Apple Silicon 版,避免 Rosetta 转译。 Linux:snap 安装最干净,但端口 10533 可能被占用,启动前 lsof -i:10533 检查。 Chrome 插件版已停止维护,建议转桌面版。 公司代理环境:Settings → Proxy → 勾选“Use system proxy”即可,NTLM 认证需 9.13+。

  3. 核心 6 步闭环 Create:新建 Collection 命名规范“业务域_模块_v1” Send:先点 Save 再 Send,避免 200 行参数丢失 Test:至少写 3 条断言——状态码 + 业务码 + 核心字段存在 Debug:控制台 console.log() 打印变量,右侧 Console 面板实时看 Doc:右键 Collection → Publish Docs → 自定义 Logo 与域名 Share:生成 Run in Postman 按钮,贴到 GitHub README, star 翻倍。

  4. 环境变量高阶玩法 多层继承:Global < Collection < Environment < Local(Pre-script) 秘钥加密:使用 pm.environment.set("pwd", CryptoJS.AES.encrypt(pwd, key)) DotEnv 导入:cat .env | xargs -I {} postman collection run -e demo.json --env-var {} 切换环境快捷键:Ctrl+Alt+E(Win)/ ⌥+⌘+E(Mac),比鼠标快 3 倍。

  5. 代码案例(略,见上文)

  6. CI/CD 模板(GitHub Actions)

name: API Test
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with: node-version: 18
      - run: npm i -g newman
      - run: newman run https://www.getpostman.com/collections/xxx -e test.postman_environment.json
      - name: Upload Report
        uses: actions/upload-artifact@v4
        with:
          name: api-report
          path: report.html

推送即跑,失败自动回滚,Slack 通知 30 秒接入。

  1. Mock Server 实战 1)Collection 右键 → Mock Collection → 生成 https://xxx.mock.pstmn.io 2)实例:GET /user 返回

{
  "id": 1,
  "name": "{{$randomFirstName}}"
}

3)前端 axios 直接指向 Mock 地址,后端开发零阻塞。 4)支持延迟响应、动态随机数据、条件跳转(根据 Header 返回不同 JSON)。

  1. 性能/压力摸底 Collection Runner → Iterations 1000,Delay 0,Concurrency 10 结果看 95th percentile 响应时间;>1s 的接口标红,列入优化清单。 注意:免费账号并发上限 25,企业版可 1000+。

  2. 团队治理 Collection 版本号:v1.0.0 三位语义化,变更必须 PR 命名空间:统一小写+下划线,禁止空格 敏感信息:使用“Current Value”只保存在本地,勾选 Secret 自动星号 Code Review:每条 Test 脚本至少 1 人 approve,才能合并到 master 分支

  3. 常见报错 30 例速查(节选) 401 Unauthorized:环境变量 token 未刷新,Pre-script 加自动刷新逻辑 415 Unsupported Media Type:忘记加 Content-Type: application/json ECONNREFUSED:本地服务没起或端口占用 CERT_HAS_EXPIRED:系统时间错 or 抓包工具证书冲突,更新 ca-certificates 429 Too Many Requests:触发了接口限流,Runner 里加大 Delay

  4. 快捷键大全(精选) Ctrl+K:快速切换接口(堪比 VS Code 命令面板) Ctrl+Alt+C:复制当前请求为 cURL Ctrl+Shift+I:打开开发者工具(调试用) 完整双表(Win/Mac)已整理成 PDF,文末下载。

  5. 插件与生态 VS Code:安装“Postman”插件,集合文件语法高亮 IntelliJ:JetBrains 官方插件,一键导入 .postman_collection Apifox 迁移:Settings → Export → Collection v2.1,Apifox 直接识别 CLI 全家桶:Newman、Postman CLI、Postman Insights(性能分析)

  6. 学习路线图 0 基础:跑通 GET/POST,写 1 条断言(1 天) Lv1:掌握环境变量、Mock、Runner(1 周) Lv2:接入 CI/CD、性能摸底、团队规范(1 月) Lv3:写自定义 SDK、插件开发、贡献开源(3 月) 每阶段配套书单/视频/B 站 up 主,思维导图里扫码即看。

  7. 资源汇总 官方文档:https://learning.postman.com/ 官方示例库:https://github.com/postmanlabs/postman-collection 高清思维导图+快捷键 PDF+CI 模板:https://pan.quark.cn/s/xxxx(免登录) 社区直播日历:https://www.postman.com/events/

7. 结语

Postman是一款强大的API开发工具,它提供了丰富的功能和友好的界面,使得开发者可以更轻松地处理API相关的任务。通过合理使用Postman,你可以提高API的开发效率和质量,加快软件开发的进度。

postman更多功能请看官方文档(Postman 文档概述 |邮递员学习中心https://learning.postman.com/docs/introduction/overview/),会持续更新。

10 个高频关键字(面试/实操都能用)

  1. Collection:请求文件夹,可一键分享、版本管理。

  2. Environment:变量作用域,全局/环境/本地三层隔离。

  3. Pre-request Script:请求前钩子,常用来生成签名、时间戳。

  4. Tests:响应断言区,支持 Chai 语法,自动统计通过率。

  5. Mock Server:Postman 云端给返回假数据,前端无需等后端。

  6. Monitor:定时云调度集合,异常自动邮件提醒。

  7. Newman:官方 CLI 工具,把 Postman 跑在服务器/流水线。

  8. Runner:批量跑集合,可做并发/性能摸底。

  9. API Documentation:一键生成可交互网页,支持自定义域名。

  10. Workspace:团队协作空间,实时同步集合、环境、评论。

官方资源直通车
官网下载:https://www.postman.com/downloads/
官方文档:https://learning.postman.com/
Newman GitHub:https://github.com/postmanlabs/newman
社区论坛:https://community.postman.com/
(收藏这 4 个链接,90% 问题都能自己解决)


结语
把上面 3 个案例跑通,你就已经领先 80% 只点 Send 的选手;再把关键字和官网丢进收藏夹,基本就能冒充“API 测试专家”了。祝你 0 error,0 warning,测试全绿!

评论 6
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

正在走向自律

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值