API接口规范

2023-11-08 11:32:23 阅读:3 编辑
  1. api 接口必须加版本号,初始版本 【v1】
  2. 格式统一:

    {
      "code" : 0,
      "msg" : "Something bad happened",
      "data" : {
    
      }
    }

    code: 0为成功,非0为失败。可以自定义code,代表不同的错误码

msg: 当code为非0时,获取错误信息。当code为0时,msg一般为”success”。如果有需要也可以另外作规定

data: 当code为0时,获取结果,全部以json方式表示。当code为非0时,data没有数据

Path具体的实现 path = /{版本}/{具体的业务功能}/{表名}/{行为}

1.{版本}:开始时全部为V1, 2.{具体的业务功能}:

App的setting,数据库命名为 app_setting 那么,具体的业务功能=setting 架构组的wechat,数据库命名为arch_wechat 那么,具体的业务功能=wechat

{表名}:就是数据的表名
{行为}:一般就是方法名
limit=10:指定返回记录的数量
offset=10:指定返回记录的开始位置。
page=2&per_page=100:指定第几页,以及每页的记录数。
sort_by=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。

https://developer.aliyun.com/article/709322

php+redis 实现漏桶算法限流类 https://learnku.com/articles/60337

说说 API 的防重放机制 https://learnku.com/articles/4196/talk-about-the-anti-replay-mechanism-of-api