定义模式组件

在线编辑

模式组件用于定义可复用的模式，这些模式为开发者提供在调用 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 支持。

在 OpenAPI 3.0 中创建的 API 包含一个用于定义 API 有效载荷的章节。 有效载荷定义描述了API请求和响应中传输的数据结构，采用了一种专用于 OpenAPI 的特殊JSON模式变体。 每个有效载荷定义都对应一个模式 ，该模式列出了预期数据字段。 这些数据字段在模式中以属性的形式呈现，并包含一组描述其类型、允许值、必填状态及其他特征的属性。 尽管提供了许多属性，但其中大部分很少被使用。

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

要使用模式组件，请在 API 定义中的其他位置引用该组件。 您可以从以下位置引用模式：

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

过程

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