接口概述
Postman 通过 API Builder 支持 API 优先开发。使用 API Builder 在 Postman 中设计你的 API。然后,你的 API 定义可以充当 API 项目的唯一真实来源。
你可以将 API 开发和测试过程的各种元素连接到 API 定义,例如集合、文档、测试和监视器。你还可以将 Postman 中的 API 与 Git 存储库同步。
高级步骤
以下是在 Postman 中设计和开发 API 时涉及的高级步骤:
- 创建 API - 在 Postman 中启动一个新的 API。(你也可以 导入 API 。)
- 使用 API 版本控制 - 在 Postman 和远程 Git 存储库之间同步你的更改。当你准备好与消费者分享你的更改时, 发布一个版本 。
- 开发 API - 通过 编辑你的 API 定义 和 添加集合 来构建你的 API 。你还可以根据 OpenAPI 3 规范 生成服务器端代码并 验证你的 API 定义 和链接元素。
- 测试 API - 将测试添加 到你的 API,并使用 CI 集成 来构建和自动化测试。
- 部署 API - 连接你的 API 部署服务以在 Postman 中获得更大的可见性。
- 观察 API - 添加监视器以观察你的 API。
- 管理和共享 API - 与其他团队成员共享你的 API、添加评论、查看更改日志并关注更改。
- 模拟 API - 设置模拟服务器来模拟 API 的端点以用于测试或开发目的。
- 使用 API 报告 - 使用报告查看有关你的团队如何使用、开发和改进 API 的统计信息。
导航 API 构建器
要查看和使用 API,请在边栏中选择API 。你可以从这里打开和编辑任何现有的 API,或者创建或导入新的 API。使用箭头在边栏中展开 API 并查看 API 的定义文件和链接的元素。
当你在边栏中选择一个 API 时,工作台会显示该 API 的概览。概览显示 API、链接集合和已发布版本的说明。概述还提供了对任务的快速访问,例如连接到存储库、添加测试、监视 API 和查看部署。
右侧边栏提供了更多用于使用 API 的选项。你可以查看评论、根据你的 API 定义生成服务器代码,以及查看 API 的变更日志。
对于连接到 Git 存储库的 API,更改日志由源代码管理窗格取代,你可以使用它与远程 Git 存储库同步你的更改。