创建接口(Creating)
要开始使用 API Builder,你可以在工作空间中创建一个新的 API。你还可以升级、重命名或删除现有 API。
你必须登录到你的 Postman 帐户才能创建 API。
创建 API
在边栏中选择API ,然后选择**+**。
输入新 API 的名称。
选择用于创建 API 的选项:
- 连接到 Git 存储库并将你的 API 定义和集合导入 Postman。了解有关 连接到存储库的 更多信息。
- 在没有存储库的情况下继续。
要开始使用你的新 API:
- 为你的 API 创建一个新的 API 定义 。
- 使用集合作为 API 的起点 。在你的工作空间中选择你要使用的集合,并将其副本添加到你的 API。你还可以在 API 中创建新集合。
- 从文件、文件夹、代码存储库或 API 网关 导入现有 API 定义。
Postman support OpenAPI(版本 1.0、2.0、3.0 和 3.1)、RAML(0.8 和 1.0)、protobuf(协议缓冲区)(2.0 和 3.0)、GraphQL 或 WSDL(1.0 和 2.0)定义。OpenAPI 定义可以是 JSON 或 YAML。RAML 定义必须是 YAML。Protobuf 定义是
.proto
文件。GraphQL 定义可以是 JSON 或 GraphQL SDL。WSDL 定义必须是 XML。
更新 API
Postman v10 可以显示在以前版本的 Postman 中创建的 API。要在 Postman v10 中使用 API,系统会在你对其进行更改时要求你升级 API。例如,添加集合、添加定义文件以及使用连接的 Git 存储库。
与 v9 相比,API 版本在 Postman v10 中的工作方式存在一些差异:
- 在 Postman v9 中,版本是你可以同时处理的 API 的主要迭代。在 Postman v10 中, 已发布版本 是消费者可以引用的 API 的静态表示(如 Postman v9 中的发布)。
- 如果你需要在 Postman v10 中处理 API 的一次以上主要迭代,请创建单独的 API。
- 如果在 Postman v9 中创建的 API 有多个版本,则每个版本将在 Postman v10 中显示为单独的 API。例如,如果你有一个
sample-api
以两个版本v1
and 命名的 APIv2
,它们将显示为sample-api:v1
andsample-api:v2
。
重命名 API
要更改 API 的名称,请在边栏中选择API 。 选择 API 旁边的更多操作图标 ,然后选择重命名。 你还可以在概览选项卡中选择 API 名称旁边的编辑图标 并输入新名称。
删除 API
- 在边栏中选择API 。
- 选择 API 旁边的更多操作图标 ,然后选择删除。
当你删除 API 时,API 中包含的任何 API 定义或集合也会随之删除。配置的集成也将被删除。