指定网关和门户网站设置

在线编辑

为 API 定义常规配置设置。

关于本任务

注：
  • 此任务与配置 OpenAPI 3.0 API 定义相关。 有关如何配置 OpenAPI 2.0 API 定义的详细信息，请参阅 编辑 OpenAPI 2.0 API 定义。
  • OpenAPI 3.0 API 仅支持 DataPower® API Gateway，而不支持 DataPower Gateway (v5 compatible)。
  • 有关当前 OpenAPI 3.0 支持限制的详细信息，请参阅 IBM® API Connect 中的 OpenAPI 3.0 支持。

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

您随时可以通过点击“源代码”图标 OpenAPI 源图标，直接切换到底层的 OpenAPI YAML源代码。 要返回设计表单，请点击 “表单 ”图标 表单图标。

过程

  1. 打开 API 以进行编辑，如 编辑 OpenAPI 3.0 API 定义中所述。
  2. 选择 网关 选项卡，然后单击 网关和门户网站设置。
  3. 提供以下信息：
    • 阶段：API 所处的生命周期的阶段；请选择下列其中一个选项：
      • 已实现 (缺省值)- API 处于实现阶段。
      • 已识别 - API 处于早期概念阶段，既未完全设计也未实现。
      • 指定 - API 已完全设计并通过内部里程碑，但尚未实现。
    • 可测试 ：选择此选项，允许使用 “消费者目录 ”中的测试工具对 API 的操作进行测试。
      注: 要使测试工具工作，必须在目录中登台的产品的计划中包含 API。
    • CORS：对 API 启用和配置跨源资源共享 (CORS) 支持。 有关详细信息，请参阅 《为 API 启用 CORS 支持 》。
    • 目标服务: 定义要在 API 定义中使用的 Web Service。 有关详细信息，请参阅 “为 API 定义目标服务 ”。
    • 强制: 选择此选项以使用 DataPower API Gateway强制实施 API。 如果要在 DataPower API Gateway以外的网关上管理 API ，请清除此选项。 尽管该 API 尚未通过 发布到网关，但应用程序开发人员仍可在 “消费者 API Connect目录”中订阅该未强制执行的 API。
    • 属性：添加可在 API 定义中引用的属性。 有关详细信息，请参阅 “设置 API 属性 ”。
    • 目录属性：定义特定于特定目录的属性值。 有关详细信息，请参阅 “定义目录特定属性值 ”。
    • 活动日志：为分析中存储的 API 活动配置日志记录首选项。 有关详细信息，请参阅 “配置活动日志记录 ”。
    • Exx令: 已向 API 添加扩展以扩展 OpenAPI 规范。 有关详细信息，请参阅 《在 API 中添加 OpenAPI 扩展》。