定义操作的参数

在线编辑

对于与特定操作相关联的 URL 路径，操作参数可以定义 URL 路径、查询参数、头或主体参数的变量元素。

关于本任务

注：
  • 此任务与配置 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 来完成此任务。

操作参数将覆盖父路径上定义的同名参数；请参阅 “为路径定义参数 ”。

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

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

过程

  1. 打开 API 以进行编辑，如 编辑 OpenAPI 3.0 API 定义中所述。
  2. 展开 路径，然后展开所需的路径。
  3. 展开 操作，然后展开所需的操作。
  4. 您可以创建新的操作参数，也可以编辑任何现有参数。
    • 要创建操作参数，请单击 “参数” 旁边的添加 OpenAPI 3.0 API 添加图标 图标，然后参阅 “创建参数 ”。
    • 要编辑现有操作参数，请在导航窗格中单击参数名称，然后参阅 “编辑参数 ”。