参数设置

参数设置适用于 HTTP 类型的 API 服务。通过自动导入方式创建的 API 无需配置参数。

• 请求参数：设置 Path 中的动态参数和 URL Query 参数，参数名称保证唯一。

  • 参数名称：必填，参数的名称。

    说明

    如果为 Path 参数，请保证名称与请求 Path 中的一致。例如，请求 Path 为 /pets/${id}，此时参数名称应为 id。

  • 参数位置：必填，参数位于 Path 或者 Query String 中。

  • 类型：必填，可选择的类型有 String、Int、Long、Float、Double、Boolean。

  • 默认值：选填，参数的默认值。

  • 描述：选填，参数描述。

• 请求 Body：指定请求 Body 的数据模型及 Content-Type。

  说明

  仅当 API 的调用方式为 POST 时，才会展示请求 Body 配置。

  • 请求 Body 类型：支持的 Body 类型有 String、Int、Long、Float、Double、Boolean、List、Map、Object。

  • 报文类型：支持的报文类型有 application/json、application/x-www-form-urlencoded、application/protobuf。

• 响应结果：指定响应结果的类型。

  • 响应结果类型：指基础类型或者自定义的数据模型。