定义路径的参数

路径参数可以指定 URL 路径、查询参数、头或请求主体的变量元素。 这些参数适用于在路径下定义的所有操作。 可以在操作级别覆盖路径参数,但无法将其移除。

关于此任务

注: 此任务与配置 OpenAPI 2.0 API 定义相关。 有关如何配置 OpenAPI 3.0 API 定义的详细信息,请参阅 编辑 OpenAPI 3.0 API 定义

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

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

过程

  1. 打开 API 以进行编辑,如 编辑 OpenAPI 2.0 API 定义中所述。
  2. 展开 路径
  3. 展开所需的路径,如果已定义一个或多个参数,请展开 路径参数
  4. 您可以创建新参数,也可以编辑任何现有参数。
    • 要创建参数,请单击 路径参数旁边的 "添加" 图标 OpenAPI 2.0 API 添加图标 ,然后参阅 创建参数
    • 要编辑现有参数,请单击导航窗格中的参数名称,然后参阅 编辑参数