接口规范初探

缘起

在前后端对接的过程中,如果接口返回数据类型不稳定,经常会导致前端需要各种兼容,极易出现错误。鉴于此,这里探讨一下更合理的接口,方便前后端协作,减少bug,提升开发速度

甚至之后可以进一步的拓展为自动化生成接口调用

规范建议(根据实践,可增删)

  • 数字类型:如果为空返回0
  • object类型:如果为空返回null
  • 字符串类型:如果为空返回‘’
  • array类型:如果为空返回[]
  • object.object类型
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//例如:
{
test: {
name: 'test';
num: 1
}
}
//如果name,num为空

//应该返回
{
test: {
name: '';
num: 0
}
}

//不应该返回

{
test: null
}

参考资料

https://legacy.gitbook.com/book/geemus/http-api-design/details
http://jsonapi.org/