跳到主要内容

Postman 中文文档

欢迎来到 Postman 中文学习文档!这里提供了有关如何在 API 项目中使用 Postman 的指南,文档内容由 官方文档 翻译而来,想要学习更多编程相关的知识,欢迎访问 犀牛书 中文文档技术大全。

如果你正在学习在 Postman 中执行特定的任务或工作流程,请查看以下主题以找到资源:

入门指南

要开始使用 Postman,请查看 入门指南 部分。

发送请求

你可以在 Postman 中发送请求以连接到你正在使用的 API。要了解有关如何发送请求的更多信息,请参阅 发送请求 并学习如何 发送你的第一个请求

编写脚本

Postman 基于 Node.js 提供了一个强大的运行时环境,使你能够为请求和集合添加动态行为。你可以编写在请求执行前或执行后运行的脚本,以执行 API 测试、构建包含动态参数的请求、在请求之间传递数据等。要了解有关脚本的更多信息,请参阅 Postman 中的脚本编写

使用集合

Postman 集合是一组保存的请求。你可以使用集合来组织和分组请求,并一起运行。你可以手动运行集合,按计划运行集合,从 CI/CD 流程运行集合,或从 Webhook 运行集合。要了解有关集合的更多信息,请参阅 集合概述

使用 Postman Flows

Postman Flows 是一个用于创建 API 工作流的可视化工具。你可以使用 Flows 来链接请求、处理数据,并在 Postman 工作空间中创建真实世界的工作流程。

要了解有关 Postman Flows 的更多信息,请参阅 Postman Flows 概述

使用 Postman CLI

Postman CLI 是 Postman 的安全命令行伴侣。你可以使用 Postman CLI 运行集合、将运行结果发送给 Postman、检查 API 定义与配置的 API Governance 和 API 安全规则是否一致,以及执行其他操作。

要了解有关 Postman CLI 的更多信息,请参阅 Postman CLI 概述

在 Postman 中协作

Postman 提供了多种工具,可在团队内进行协作并加强协作。你可以创建团队工作空间,团队成员可以共享工作并在 API 项目上进行协作。用户还可以在 Postman 中直接讨论工作,例如对集合和 API 进行评论,包括对特定请求、版本以及 API 定义和脚本的评论。

要了解有关在 Postman 中进行协作的更多信息,请参阅 协作概述

设计和开发你的 API

Postman support 使用 API Builder 进行 API 优先开发。使用 API Builder 在 Postman 中设计你的 API。然后,你的 API 定义可以作为 API 项目的唯一真实性来源。

你可以将 API 开发和测试过程的各个元素与 API 定义连接起来,例如集合、文档、测试和监视器。你还可以将 Postman 中的 API 与 Git 存储库同步。

要了解有关 API 优先开发的更多信息,请参阅 API 开发概述

文档化你的 API

文档是任何集合或 API 的重要组成部分。良好的文档可以帮助使用你的集合的人了解其功能以及每个请求的工作原理。全面的 API 文档可以让使用者了解可用的端点以及如何与其进行交互。

生成集合或 API 的文档后,用户可以在 Postman 中查看文档。默认情况下,你的文档是私有的,因此在他人可以访问之前,你必须与其他人共享集合或 API。如果你正在创建公共 API,可以发布你的文档,使任何使用 Web 浏览器的人都可以访问。

要了解有关文档化你的 API 的更多信息,请参阅 生成 API 文档

监控你的 API

Postman 监视器可以持续监视和评估 API 的健康状况和性能。监视器可以运行一系列请求,来自你设置的计划。要了解有关使用监视器的更多信息,请参阅 监控你的 API

API Governance 和 API 安全

API Governance 是定义和应用开发规则的实践,以促进组织 API 环境中的一致 API 行为。强大的 API 安全姿态意味着你的组织具有促进以安全为先的 API 行为的开发规则。Postman 的 API Governance 和 API 安全功能可以识别 API 中的不一致或弱点,并推荐可能的修复或改进。

要了解有关 Postman 的 API Governance 和 API 安全功能的更多信息,请参阅 Postman 中的 API Governance 和 API 安全

管理

Postman 提供了多种选项来定制团队的体验,从初始设置到持续的团队和计划管理。作为团队管理员,你可以简化团队的入职流程、管理访问控制,并使团队始终使用最新版本的 Postman。

要了解有关管理 Postman 团队的更多信息,请参阅 管理 部分。

使用报告

Postman 生成报告,使你可以可视化团队使用 Postman 的数据。这些报告让你了解 API 的状态,包括测试、文档和监控覆盖率。它们还可以帮助你跟踪性能和服务级别协议的遵守情况。

要了解有关如何使用报告的更多信息,请参阅 报告概述

开发人员资源

如果你正在将 Postman 集成到 CI/CD 工作流程中,或者正在使用 Postman API 或库进行开发,请查看 开发者资源

集成

你可以通过与常用的第三方解决方案集成,将 Postman 与你的 API 工作流程连接起来。使用集成可以在 Postman 和其他 API 开发工具之间自动共享数据。有关更多信息,请参阅 与 Postman 集成