码迷,mamicode.com
首页 > 其他好文 > 详细

项目中接口的书写应该遵守的一些原则

时间:2016-12-08 23:48:29      阅读:279      评论:0      收藏:0      [点我收藏+]

标签:ice   字段   实体   事物   链接   项目   原则   状态   方法   

1.接口的命名一定要规范,不能够和实体,方法名产生混淆,便于识别

 

2.接口返回的字段最好不要包含中文字段

  ---容易乱码

 

3.接口返回如果有多个状态,使用int 类型进行定义。

    --- 1 是状态1

         2 是状态2

         3 是状态3

        ...

 

4.书写接口文档,一定要和返回的字段相符,没有的就不要写出来

    --- 接口文档不是给你用的,希望与你交接的人能够无缝链接

 

5.接口返回的字段一定要完整,不要有的时候有,有的时候没有,解析的时候容易出错。

    --- 有就返回值,没有就返回null

 

6.自己书写的接口,自己一定要测试清楚,传入参数,要进行各种判断

 

7.接口的逻辑部分要放到service层,进行事物流的处理

 

8.接口的通用方法,进行抽取

 

9.自己的接口,逻辑一定要清楚(一定要清楚...)

 

项目中接口的书写应该遵守的一些原则

标签:ice   字段   实体   事物   链接   项目   原则   状态   方法   

原文地址:http://www.cnblogs.com/mr-wuxiansheng/p/6146883.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!