浅谈API编写中的注意事项

2020-11-12 06:36:00 by wst

web开发

---

在实际的项目开发过程中，如果有清晰明确的规范会减少很多不必要的麻烦。比如：字段少传了、字段传空了、返回报错崩溃了。

 

根据最近遇到的一些问题，做如下约定：

1 字段约定

确定哪些是必传字段，比如：开始时间、结束时间、渠道id。

只要有一个没传，立马给前端返回参数错误。

 

2查询结果为空

如果查询结果为空，这是一种正常情况。

返回数据的时候，首先状态码要给1，其次返回空数组即可。

 

3异常提示

后端代码在处理的过程中，难免报错。

此时要给出一个友好的提示，比如：“查询过程错误，请重试。”、“系统内部错误，请联系管理员”。

否则的话，用户会一脸懵逼；甚至会骂两句--什么垃圾系统

 

总结

这里主要说了最近遇到的问题。

实际当中需要注意的问题还有很多，后续如遇到再来补充。

 

---