前后端接口规范

370 阅读1分钟

1 前端请求格式

##a 普通请求 fetch("xxx", { method: "post", headers: { "Content-type": "application/json; charset=UTF-8" }, body: JSON.stringify(params) }) ##b 文件请求格式

  const formData = new FormData()
  formData.append("xxx", "xxx");
  return fetch("xxx", {
    method: "post",
    body: formData
  })

后端返回格式

a返回格式 (扁平化,嵌套不超过三层)

{
    "response_code": 0,    // 0: 全部添加成功,-1:有部分IP或全部添加失败
    "verbose_msg": "OK"
    "data": {               // 成功或没成功的ip和原因
        "succeed": ["1.1.1.1", "2.2.2.2"],
        "failed": [
            {
                "key": "1.1.1.1",
                "desc": "格式不符合要求"
            }
        ]
    ]
}

请求参数

b请求参数统一(讨论)是否可以传多余参数 (讨论)参数为null的情况(讨论)默认参数(讨论)

time_range: "twenty_four_hours"
occ_time_range: "seven_days",

origin_occ_time_from
time_from

c返回参数统一(讨论)

gangs
family
type intel_type intel_type
reason alert_reason