编辑参数

参数用于定义 URL 路径、查询参数、头或请求主体的变量元素。 您可以编辑先前为 API 或为 API 定义中的路径和路径操作创建的参数。

准备工作

打开参数的详细信息表单。 有关 API 定义中可编辑参数的区域详细信息，请参阅以下主题：

关于此任务

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

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

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

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

过程

  1. 提供以下信息：
    • 描述: 参数的描述。 您可以将 CommonMark 语法 用于富文本格式表示。
    • 类型: 参数的数据类型。
    • 格式: 选择数据格式; 可用选项取决于所选的 类型。
    • 根据需要选择以下选项：
      • 必需：确定此参数是否为必需。 如果位于属性设置为路径，那么必须选择此选项。
      • 允许空值: 允许发送具有空值的参数。 仅当位于属性设置为查询时，此选项才有效。
  2. 完成后单击 保存 。

后续操作

如果需要，请使用面包屑跟踪以浏览至所处理对象的层次结构中的其他位置。