请求约束
GET,DELETE,HEAD方法,参数风格必须为标准的GET风格的参数,如?a=1&b=2POST,PUT,PATCH,OPTIONS方法默认情况下请求实体会被视作标准 JSON 字符串进行处理,应该设置头信息的Content-Type为application/json,在一些特殊接口中,可以允许Content-Type为application/x-www-form-urlencoded或者multipart/form-data,此时请求实体会被视作标准POST风格的参数进行处理- 在特殊场景下,例如查询参数长度超过浏览器限制、不允许使用
DELETE方法等,可以使用POST方法代替 - 使用过滤查询时,基本查询和高级查询必须不能同时使用
参数命名
参数定义必须使用 lower_case_underscore_separated_names 格式
参数名称必须是英文或英文和数字的组合
参数名称不应该包含介词(例如 for、during、at),例如:
reason_for_error应该改成error_reasoncpu_usage_at_time_of_failure应该改成failure_time_cpu_usage
参数名称不应该使用后置形容词(名词后面的修饰符),例如:
items_collected应该改成collected_itemsobjects_imported应该改成imported_objects