Skip to content

请求约束

  • GET, DELETE, HEAD 方法,参数风格必须为标准的 GET 风格的参数,如 ?a=1&b=2
  • POST, PUT, PATCH, OPTIONS 方法默认情况下请求实体会被视作标准 JSON 字符串进行处理,应该设置头信息的 Content-Typeapplication/json,在一些特殊接口中,可以允许 Content-Typeapplication/x-www-form-urlencoded 或者 multipart/form-data ,此时请求实体会被视作标准 POST 风格的参数进行处理
  • 在特殊场景下,例如查询参数长度超过浏览器限制、不允许使用 DELETE 方法等,可以使用 POST 方法代替
  • 使用过滤查询时,基本查询和高级查询必须不能同时使用

参数命名

参数定义必须使用 lower_case_underscore_separated_names 格式

参数名称必须是英文或英文和数字的组合

参数名称不应该包含介词(例如 forduringat),例如:

  • reason_for_error 应该改成 error_reason
  • cpu_usage_at_time_of_failure 应该改成 failure_time_cpu_usage

参数名称不应该使用后置形容词(名词后面的修饰符),例如:

  • items_collected 应该改成 collected_items
  • objects_imported 应该改成 imported_objects

基于 VitePress 构建