编辑参数

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

1. 提供以下信息：
   • 名称：编辑参数组件时可用，此名称定义一个键，该键支持在 API 定义中的其他位置引用此参数；该引用具有以下格式：

     #/components/parameters/Name

     要更改名称，请单击 更新，然后在完成时单击 保存 。
   • 参数名称（必需）：参数的名称。
   • 位于（必需）：参数的位置。 选择下列其中一个选项：
     • 查询：附加到 URL 的参数。 例如，url_path?myparam=myvalue。
     • 头：需要包含在请求中的定制头。
     • 路径：参数值是操作 URL 的一部分，包含在 {} 中。
     • cookie：用于将特定 cookie 值传递到 API。
   • 描述: 参数的描述。 您可以使用 CommonMark 语法进行富文本表示。
   • 样式：描述参数值的序列化方式，具体取决于参数值的类型。 选择下列其中一个选项：
     • 矩阵路径式参数定义为 RFC6570.
     • 标签定义的标签样式参数 RFC6570.
     • 简单定义的简单样式参数 RFC6570.
     • form ：定义的表单样式参数 RFC6570.
     • spaceDelimited：用空格分隔的数组值。
     • pipeDelimited：用竖线分隔的数组值。
     • deepObject：提供使用表单参数来呈现嵌套对象的简单方式。
   • 根据需要选择以下选项：
     • 必需：确定此参数是否为必需。 如果位于属性设置为路径，那么必须选择此选项。
     • 已弃用：指定已弃用某个参数，并且应将其转换为停用。
     • 允许空值：允许使用空值发送参数。 仅当位于属性设置为查询时，此选项才有效。
     • 分解：如果选中此项，那么 array或object 类型的头值会为映射的数组或键/值对的每个值生成单独的头。
     • 允许保留 ：确定参数值是否允许包含保留字符，保留字符由 RFC3986 (:/?#[]@!$&'()*+,;=) 所定义的保留字符，而不进行百分比编码。 仅当位于属性设置为查询时，此属性才适用。
   • 模式:

     要为参数定义模式，请单击创建 ，然后参阅创建模式组件。

     如果参数已定义模式，请单击查看以编辑模式。

     有关编辑模式的详细信息，请参阅编辑模式组件。

     注意： 如果模式引用了模式组件，则无法编辑模式，模式配置由模式组件继承；有关配置模式组件的详情，请参阅定义模式组件。 但是，您可以编辑引用的模式组件，而所有更改将反映在引用模式组件的任何位置。
   • 示例值：参数值的示例。 您在此处输入的任何内容都将按原样显示在 Developer Portal中。
2. 完成后单击 保存 。