创建新的 REST OpenAPI 定义

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

关于此任务

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。

仅适用于 API Manager UI: 要完成此任务，必须为您分配具有 Api-Drafts:Edit 许可权的角色。 缺省情况下，预提供的开发者角色具有此许可权；如果为您分配了定制角色，那么该角色必须具有此许可权。 有关更多信息，请参阅 创建定制角色。

过程

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

  1. 在导航窗格中，单击 API UI 导航窗格中的 "开发" 图标 开发，然后单击 添加 > API。
    这样会显示选择 API 类型屏幕。
  2. 根据 API 要基于的 OpenAPI 规范版本，选择 OpenAPI 2.0 或 OpenAPI 3.0 。
  3. 选择 新建 OpenAPI 。
  4. 单击下一步。 在信息部分中指定 API 摘要。 您可以在创建 API 之后进行优化。
    • 标题可以包含特殊字符，但是应保持简短，以便于在用户界面中显示。
    • 将自动输入 名称 。 名称 字段中的值是用于在 developer toolkit CLI 命令中标识 API 的单个字符串。 要查看用于管理草稿 API 的 CLI 命令，请参阅 工具箱 CLI 参考文档。
    • 版本 对应于 API 的 OpenAPI 定义的 info.version 属性值。 建议使用 version.release.modification 版本编号方案，例如，1.0.0。
    • 基本路径是 API 的 URL 段，并且不包含主机名或者路径或操作的任何其他段。 基本路径不能包含特殊字符，并且必须以 / 字符开头，即使该字符在其他情况下为空也是如此。
    • 可选的描述有助于识别 API。
  5. 单击下一步。 在安全部分中，配置您需要的 API 安全性。
    • 使用客户机标识进行保护 - 选择此选项可要求应用程序提供客户机标识（API 密钥）。 这将导致 X-IBM-Client-Id 参数包含在 API 的请求头中。 如果选择此选项，那么可以选择是否限制每个密钥（每个客户机标识）的 API 调用数：
      • 限制每个密钥的 API 调用数 - 如果选择此选项，那么必须配置所需的速率限制。 速率限制可控制某一时间段（小时、分钟、月或日）内允许的最大调用次数。 例如，每小时 100 次调用。
    • CORS － 选择此选项来为 API 启用跨源资源共享 (CORS) 支持。 这将允许从其他域访问您的 API。
      注：
      • CORS 支持仅在 DataPower® API Gateway上可用。
      • 启用 CORS 时，API 网关会运行 cors 预流策略以处理针对 API 发出的所有 CORS 请求。
      • 启用 CORS 并收到预检请求时，仅执行以下 API 操作：
        • cors 预流策略配置相应的响应头。
        • 将设置响应头。
      • 收到预检请求时，request.attributes.isCORSPreflight 标志将设置为 true。
      • 对于所有预检请求，始终跳过 security 和 client-identification 预流策略，无论是否启用 CORS 都是如此。
  6. 单击 下一步 以创建 API 定义。

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

  7. 选择以下某个选项：
    • 要进一步配置 API，请单击编辑 API。 有关详细信息，请参阅 编辑 API 定义。
    • 如果此时不想要进一步配置 API，请单击面包屑跟踪中的开发链接，以返回到欢迎页面；随后即可立即继续处理其他任务。 有关以后如何配置 API 的详细信息，请参阅 编辑 API 定义。

结果

您已成功创建了 REST API 定义。 对于 API Designer， API 和产品的规范存储在您登录时指定的目录中。 对于 API Manager， API 和产品的规范存储在管理服务器上。

后续操作

通过将 API 包含在产品中，然后将该产品发布到目录中，应用程序开发人员就可以使用这些 API。 更多信息，请参阅使用产品和使用目录。