项目接口书写心得(1)

简介: 目前在公司的工作主要是写前端的接口工作,会和前端的同事配合比较多;这里记一下,自己在项目前端接口书写过程中的一些错误,减少再犯的可能性。 1.接口的返回值的格式    --- list集合外面不需要再包一层(这里针对自己的项目而言) 2.接口的返回值和自己书写的文档要一致   --- 返回值类型   --- 返回值定义的名称  3.自己接口的业务逻辑要清楚,不要不知道自己这个接口是干嘛的?  4.有返回值就返回,没有的话,就是NULL --- 不要返回一个空的,但是没有值  5.如果这个接口方法定义是有返回值的,那么在接收完参数之后,要return 结果。

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

 

1.接口的返回值的格式

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

 

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

   --- 返回值类型

   --- 返回值定义的名称

 

 

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

 

 

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

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

 

 

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

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

 

相关文章
|
6月前
|
前端开发 JavaScript
工作中代码书写规范
前端代码规范增进代码整洁与团队协作,降低维护成本。包括代码规范、风格和注释建议:选择编程语言对应的编码规范,统一命名、缩进和换行规则;注重代码风格的一致性、简洁性和可配置性;注释要简洁明了,位于关键位置。通过制定规范文档、使用代码检查工具、定期代码审查和鼓励改进来执行规范,提升团队效率和代码质量。
69 0
|
3月前
|
前端开发
前端代码书写规范
【8月更文挑战第15天】前端代码书写规范
60 0
|
6月前
|
存储 缓存 算法
代码简洁之道:我们该如何规范代码的命名?
代码简洁之道:我们该如何规范代码的命名?
110 1
|
6月前
|
算法 Unix 程序员
【C/C++ 基本知识 注释规范】C/C++中注释方式以及规范
【C/C++ 基本知识 注释规范】C/C++中注释方式以及规范
84 0
|
6月前
|
Java
提高代码质量的秘诀:类、方法、字段和包注释
提高代码质量的秘诀:类、方法、字段和包注释
66 0
|
程序员
代码的规范
代码的规范
159 0
|
Java
开发规范实战(一)代码书写规范
开发规范实战(一)代码书写规范
202 0
开发规范实战(一)代码书写规范
|
Java Android开发
java开发的格式与书写规范
java开发的格式与书写规范
314 0
java开发的格式与书写规范
|
API C++ Windows
C++命名规则&书写规范
C++命名规则&书写规范
1055 0