项目中接口的书写应该遵守的一些原则
Posted Mr_伍先生
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了项目中接口的书写应该遵守的一些原则相关的知识，希望对你有一定的参考价值。
1.接口的命名一定要规范,不能够和实体，方法名产生混淆，便于识别
2.接口返回的字段最好不要包含中文字段
---容易乱码
3.接口返回如果有多个状态，使用int 类型进行定义。
--- 1 是状态1
2 是状态2
3 是状态3
...
4.书写接口文档，一定要和返回的字段相符，没有的就不要写出来
--- 接口文档不是给你用的，希望与你交接的人能够无缝链接
5.接口返回的字段一定要完整，不要有的时候有，有的时候没有，解析的时候容易出错。
--- 有就返回值，没有就返回null
6.自己书写的接口，自己一定要测试清楚，传入参数，要进行各种判断
7.接口的逻辑部分要放到service层，进行事物流的处理
8.接口的通用方法，进行抽取
9.自己的接口，逻辑一定要清楚（一定要清楚...）
以上是关于项目中接口的书写应该遵守的一些原则的主要内容，如果未能解决你的问题，请参考以下文章