定义头组件

在线编辑

头组件定义了可在 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 定义中的其他位置引用该组件。

头与参数类似，但具有以下差别：
  • 参数携带实际数据，并对最终用户可用，头携带与请求或响应关联的元数据，并对最终用户隐藏。
  • 参数可以具有各种位置，头的位置始终设置为 header。
  • 参数可以具有各种格式样式，头的样式始终为 simple。
有关参数的更多信息，请参阅 创建参数。

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

过程

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