导入接口(Importing)
你可以将现有的 API 定义导入你的 API。API 定义可以从本地文件或目录、URL、原始文本、代码存储库或 API 网关导入。
导入 API 定义
选择导入。
选择文件、文件夹,输入 API 链接,或粘贴你的原始文本。
你还可以从代码存储库导入 API 定义。了解有关 导入和导出的 更多信息。
确认名称、格式以及你希望数据导入的格式。
选择查看导入设置以获得更多配置选项。这些选项将根据你的 API 规范而有所不同。
选择“导入”将你的数据导入 Postman。
导入多文件 API 定义
选择导入。
选择文件夹,然后选择包含你的 API 文件的本地文件夹。
你还可以从代码存储库导入 API 定义。了解有关 导入和导出的 更多信息。
选择上传。当要求确认上传文件时,再次选择上传。
选择要为 API 定义导入的文件。
(可选)选择导入 OpenAPI 文件。
(可选)选择查看导入设置以获得更多配置选项。这些选项将根据你的 API 规范而有所不同。
选择“导入”将你的 API 定义导入 Postman。
要了解有关使用多文件 API 定义的更多信息,请参阅 编辑 API 定义 。
从 Amazon API Gateway 导入 API 定义
Amazon API Gateway 使开发人员能够发布和管理访问 AWS 和其他网络服务和数据源的 API。你可以将 API 直接从 AWS Gateway 导入到 Postman。这将创建与 API 网关的集成。连接后,你可以在 Postman 中查看 API 部署状态和历史记录。你还可以查看每个阶段的 Amazon CloudWatch 指标,以深入了解你的 API 的运营情况。
此集成支持为 HTTP 和 REST API 导入 OpenAPI 3.0 定义。导入定义将在 Postman 中创建一个新的 API,并且还将配置与 AWS API Gateway 的集成。
要从 AWS API Gateway 导入 API,请执行以下操作:
- 选择导入。
- 选择API 网关,然后选择AWS API 网关。
- 按如下方式连接到 AWS API 网关。
从 AWS API Gateway 导入 API 时,你可以选择通过创建 AWS IAM 角色或使用 AWS 访问密钥进行身份验证。按照你选择的方法执行以下步骤:
使用 AWS IAM 角色进行身份验证
要使用 AWS IAM 角色设置与 Amazon API Gateway 的连接,请执行以下操作:
在AWS 身份验证机制下选择IAM。
选择AWS API 类型(HTTP 或 REST)。
要在 AWS 中为 Postman 创建 IAM 角色,请执行以下操作:
打开 AWS IAM 控制台 并选择创建角色。
在选择受信任实体的类型下,选择另一个 AWS 账户。
输入 Postman 的AWS 账户 ID:
258201882842
在选项下,选中需要外部 ID复选框并输入来自 Postman 的外部 ID。你可以在第 1 步:创建 IAM 角色下找到外部 ID 。
有关更多信息,请参阅 有关使用外部 ID 的 AWS IAM 指南 。
选择下一步:权限。
选择现有的 IAM 策略或选择创建策略。如果要创建策略,请使用以下 JSON 代码:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Stmt909923626743",
"Effect": "Allow",
"Action": [
"apigateway:GET",
"apigateway:PUT",
"apigateway:POST",
"cloudwatch:GetMetricData"
],
"Resource": [
"*"
]
}
]
}此策略将为 HTTP API 定义启用导出和部署。(REST API 定义不支持导出和部署。)你可以
Action
根据需要自定义 IAM 策略中的部分:"apigateway:GET"
-(必需)允许在 Postman 中查看 HTTP 和 REST API 的 API 网关部署。"apigateway:PUT"
- 允许将 HTTP API 定义 导出 到 API 网关。"apigateway:POST"
- 允许将 HTTP API 定义 部署 到 API 网关上的一个阶段。"apigateway:*"
- 将所有 GET、PUT、POST、PATCH、DELETE 权限分配给 IAM 角色。"cloudwatch:GetMetricData"
- 允许在 Postman 中 查看 CloudWatch 指标 。
选择下一步:标签。
选择下一步:审查。
添加角色名称和角色描述,然后选择创建角色。
从 AWS 复制Role ARN并将其粘贴到 Postman 中的Step 2: Enter role ARN and region下。接下来进入 API 网关所在的AWS 区域,选择**API 网关。然后,为导入的 API 输入API 名称。准备就绪后,选择“连接”**。
使用 AWS 访问密钥进行身份验证
要使用 AWS 访问密钥设置与 Amazon API Gateway 的连接,请选择AWS 身份验证机制下的访问密钥。
接下来,输入有关连接的信息:
- 选择AWS API 类型(HTTP 或 REST)。
- 输入你的 AWS 账户的访问密钥 ID和秘密访问密钥。(了解如何 在 AWS 中查找你的凭证 。)
- 进入 API 网关所在的AWS 区域,选择**API 网关**。
- 为导入的 API 输入API 名称。
准备就绪后,选择导入。导入 API 定义后,你可以 在 Postman 中查看 API 部署 。
从 Azure API 管理导入 API 定义
你可以将定义从连接的 Azure API 管理服务导入到 Postman 中的 API。导入定义将在 Postman 中创建一个新的 API,并且还将配置与 Azure API 管理的集成。了解有关 与 Azure API 管理集成的 更多信息。
要从 Azure API 管理导入 API 定义,请执行以下操作:
选择导入。
选择API 网关,然后选择Azure API 管理。
系统将提示你授权 Postman 访问你的 Microsoft Azure 帐户。授予访问权限后,你可以关闭浏览器选项卡并返回到 Postman。
输入有关要从中导入定义的 Azure API 管理服务的信息:
选择导入。
支持的 API 定义格式
Postman 直接支持导入以下格式:
- OpenAPI 3.0 和 3.1
- 昂首阔步 1.2 和 2.0
- Protobuf 2 和 3
- 图形 QL
- 卷曲
- RAML 0.8 和 1.0
- WSDL 1.1 和 2.0
- HTTP 存档 (HAR)
- Web 应用程序描述语言 (WADL)
GitHub 上也有工具可以将不同的 API 规范转换成一个可以导入的 Postman Collection: