定义示例组件

示例组件是可复用的示例，您可以将其添加到 API，以更清楚地说明 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 来完成此任务。

要使用示例组件，您必须在 API 定义中的其他位置引用该组件。

您可以随时单击源图标 OpenAPI 源图标 直接切换到底层 OpenAPI YAML 源。 要返回设计表单，请单击表单 图标 表单图标。

过程

  1. 打开 API 以进行编辑，如 编辑 OpenAPI 3.0 API 定义中所述。
  2. 展开 组件 ，如果已定义一个或多个示例组件，请展开 示例。
  3. 您可以创建新的示例组件，也可以编辑任何现有示例组件。
    • 要创建示例组件，请单击示例旁边的添加图标 OpenAPI 3.0 API 添加图标 ，然后参阅创建示例。
    • 要编辑现有示例组件，请单击导航窗格中的示例组件名称，然后参考编辑示例。