创建新的 REST OpenAPI 定义

可使用 IBM® API Connect 中的 API Manager 或 API Designer 用户界面来创建和编辑草稿 REST API 定义。

要创建新的 REST OpenAPI 定义，请完成以下步骤。

1. 在导航窗格中，单击 开发，然后单击添加 > API。 这样会显示“添加 API：创建”屏幕。
2. 选择新建 OpenAPI。
3. 单击下一步。在信息屏幕中指定 API 摘要。您可以在创建 API 之后进行优化。
   • 标题可以包含特殊字符，但是应保持简短，以便于在用户界面中显示。
   • 系统会自动输入名称。名称字段中的值是用于在 Developer Toolkit CLI 命令中标识产品的单个字符串。要查看 CLI 命令以管理草稿 API，请参阅 apic draft-apis。
   • 版本对应于 API OpenAPI 定义的 info.version 属性的值。建议使用 version.release.modification 版本编号方案，例如，1.0.0。
   • 基本路径是 API 的 URL 段，并且不包含主机名或者路径或操作的任何其他段。基本路径不能包含特殊字符，必须以“/”字符开头，即使为空时也如此。
   • 可选的描述有助于识别 API。
4. 单击下一步。在安全部分中，配置您需要的 API 安全性。
   • 使用客户机标识进行保护 - 选择此选项可要求应用程序提供客户机标识（API 密钥）。这将导致 X-IBM-Client-Id 参数包含在 API 的请求头中。如果选择此选项，那么可以选择是否限制每个密钥（每个客户机标识）的 API 调用数：
     • 限制每个密钥的 API 调用数 - 如果选择此选项，那么必须配置所需的速率限制。速率限制可控制某一时间段（小时、分钟、月或日）内允许的最大调用次数。例如，每小时 100 次调用。
     有关 IBM API Connect 中的安全性选项的信息，请参阅配置 API 安全性。
   • CORS － 选择此选项来为 API 启用跨源资源共享 (CORS) 支持。这将允许从其他域访问您的 API。
5. 单击下一步以创建 API 定义。

   “汇总”面板将在定义创建好后显示消息，并实施所选的安全性选项和速率限制。

6. 选择以下某个选项：
   • 要进一步配置 API，请单击编辑 API。有关详细信息，请参阅编辑 API 定义。
   • 如果此时不想要进一步配置 API，请单击左箭头图标 ， 以返回“API 和产品”页面；随后即可立即继续处理其他任务。有关稍后如何配置 API 的详细信息，请参阅编辑 API 定义。