注册API配置参数

第一步:请求参数配置:填写API的输入参数与常量参数,定义API请求。

APIHelp_UserGuide-3f931.png
  • 输入参数:用户可单击新增参数,根据页面配置API的请求参数。其中参数位置支持QUERY、HEAD和BODY。

  • 常量参数:参数值为固定的参数,对调用者不可见。调用API时无需传入常量参数,但后台服务始终接收用户在此处配置的常量参数及参数值。常量参数适用于固定某个参数的取值并对调用者隐藏参数的场景。

  • 请求body描述:相当于一个请求Body的示例,API调用者可参考格式。
    在定义请求参数时,可能会遇到数组类型的body请求,平台支持用户自定义Body,但自定义后,输入参数中位于body位置的参数将无效,以自定义Body内容作为请求示例。

  • 高级配置:勾选返回结果中携带Request Header 参数,用户可在输出结果中获取request header参数如下
    "Content-Encoding": web服务器支持的反馈内容压缩编码类型。
    "Connection":表示是否需要持久连接。
    "User-Agent":请求的用户代理。
    "Host":指定请求的服务器的域名和端口号。
    "Accept-Encoding":指定浏览器可以支持的web服务器反馈内容压缩编码类型。
    "Content-Length": 请求的内容长度。
    "Content-Type": "请求的与实体对应的MIME信息。

第二步:返回示例:输入正常返回结果示例和异常返回结果示例,以便API调用者参考和编写API返回结果解析代码。

第三步:错误码:支持定义错误码,填写错误码、释义、解决方案,此部分信息将放在API详情页中,对API申请者可见,以便API调用者参考并自行查找错误原因。设置可参考API返回码

错误码