API返回值

当前API返回的状态码(http_status_code)有两种200400

返回400

如果API返回了400,表明请求参数未通过验证,此时返回格式有两种

1,有具体的参数错误,多为参数校验失败

{
    "energy_amount": ["请确保该值大于或者等于 10000。"], 
    "period": ["'1X' 不是合法选项。"]
}

TIP

  • 将列出每个字段的错误原因,原因列表为数组,可能存在多个原因!

2,无具体的参数错误,多为参数校验成功,但是引起了其他错误

{"detail": "API not found"}

TIP

  • key固定为detail,并且返回结果为字符串,开发时如果要显示具体错误,需要先判断是不是为detil类型错误,再判断是否参数错误

返回200

当API返回200时,返回格式固定为

{
    "errno": 1,
    "message": 'XXXX',
    "param1": "value1",
    ...
}
  • errno为1或者0,当errno=0时表明请求正常, errno=1时表明请求遇到了问题,此时会有message参数表明原因
  • 部分请求中,会有其他的返回参数,具体以API章节的说明为准
Last Updated: