首页 > 代码库 > 项目接口书写心得(1)

项目接口书写心得(1)

 目前在公司的工作主要是写前端的接口工作,会和前端的同事配合比较多;这里记一下,自己在项目前端接口书写过程中的一些错误,减少再犯的可能性。

 

1.接口的返回值的格式

    --- list集合外面不需要再包一层(这里针对自己的项目而言)

 

2.接口的返回值和自己书写的文档要一致

   --- 返回值类型

   --- 返回值定义的名称

 

 

3.自己接口的业务逻辑要清楚,不要不知道自己这个接口是干嘛的?

 

 

4.有返回值就返回,没有的话,就是NULL

 --- 不要返回一个空的,但是没有值

 

 

5.如果这个接口方法定义是有返回值的,那么在接收完参数之后,要return 结果。

 --- 而不是继续让其往下执行(return map)

 

项目接口书写心得(1)