定义 API 规范

您可以使用其规范定义 API 的结构。您还可以从规范生成集合。

编辑架构

每个 API 版本页面中的定义选项卡都包含一个用于 API 规范的编辑器(您导入的编辑器或创建 API 时添加的示例 Postman)。

默认模式类型为 OpenAPI 3.0,默认格式为 YAML。要使用不同的架构类型或格式,请从下拉列表中选择它。

架构编辑器的左窗格显示架构的轮廓。当你第一次打开编辑器时,最顶层的节点会展开,其余的节点会折叠起来。选择节点以展开或折叠它们。在大纲中选择一个元素以在编辑器中跳转到它。您还可以选择轮廓按钮来隐藏或显示轮廓。

架构导航

在架构编辑器中,当您将鼠标悬停在#ref组件上并按下 Command 键时,弹出框会显示参考组件的前 200 个字符。当您按住 Command 键选择参考组件时,它将跳转到参考位置。

架构参考

架构编辑器的右上角是美化内容、换行、复制和搜索的选项。完成模式编辑后,选择Save

API Builder 定义选项

Postman 将在您处理架构时指出验证错误。

生成集合

Postman API Builder 通过提供直接从模式创建 Postman 集合的选项来支持 API 优先开发。保存模式后,您将在模式编辑器的右上角看到一个Generate Collection选项。

要基于您的架构创建集合,请选择Generate Collection。您可以将集合添加为文档、测试、监视器或模拟服务器。该收藏将出现在左侧边栏中的收藏中。它将链接到与架构相同的 API 版本。

生成集合

您还可以通过选择Show advanced settings来配置生成集合的方式。