规范

  • api 接口必须加版本号,初始版本 【v1】,多个版本api版本可能同时在线
  • 不使用rest的PUT和DELETE,因为很多浏览器不支持,很多框架也不支持
  • POST在需要传输大量数据的时候使用,其余使用GET就可以了;
    这里GET和POST没有明确的含义,GET也可以新增
  • 所有路径path全部小写,以下划线分隔,所有参数,包括POST里面的body,以及header使用驼峰。例如:http://127.0.0.1/v1/wechat/mch_info/list_mch_info?page=2&perPage=100
  • 我们返回一般统一使用json格式返回
  • 使用Token令牌来做用户身份的校验与权限分级
  • 暴露外部请求一定使用SSL

Path具体的实现

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

  • {版本}:开始时全部
收藏 打印