关于接口设计个人一些见解(前端)

关于key的规范要求

1. 语义化来命名key，并且遵循驼峰式和下划线式的规范
2. 前端的key和后端的key要保持一致
3. 包含多个结果的字段，用复数的形式

{
  "tags": ["食物", "粤菜", "卤水"],
}

4. 如果是数组对象的形式的时候，名词 + list结尾（一般循环遍历显示的时候，需要这种数据形式）

{
 	"memberList": [
	    {
	      "uid": 111,
	      "name": "张三",
	      "age": 22
	    },
	    {
	      "uid": 222,
	      "name": "李四",
	      "age": 27
	    }
  ]
}

5. 判断查询类的字段，注意动词的配合

动词	含义
is	是否符合某个条件
has	是否包含某个条件
can	是否能够进行某些操作

6. 使用合理的缩写，能缩写的劲量缩写，但是要保证语义化
   • 比如password ==> pwd
   • user id ==> uid
   • level ⇒ lv
   • message ==> msg

关于value的规范要求