定义路径的参数

路径参数可以指定 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 添加图标 ，然后参阅创建参数。
    • 要编辑现有参数，请单击导航窗格中的参数名称，然后参阅编辑参数。