后台开发规范

1.HTTP接口格式

不管状态码是什么,都会返回json,包含3个字段,is Error ,data 

成功格式
	{
	   is Error: false,
	   data: ${data},	
	 }
错误结果格式
	 {
           is Error: true,
           error:{
              code:"UNCAUGHT_EXCEPTION ", //错误码别名
	      codeNumber:   ,//错误码
              message: "xxx", // 错误信息
           }
	}

2.接口安全策略

  • token,请求方自带一个taken
  • 签名,提供签名算法给调用方,结果加入请求体中,正确才发挥结果
  • 用户授权,通过用户请求里的某些字段,给出相应的权限

3.配置

  • 放在配置文件里
  • 配置中心,动态生成配置文件

 4.日志

  •   访问日志:记录访问接口的ip,入参,响应时间等数据
  •   行为日志:记录关键操作信息
  •   错误日志:打印详细错误信息,帮助调试及修复

猜你喜欢

转载自blog.csdn.net/qq_38930240/article/details/83141626