项目接口书写心得(1)

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

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

 

1.接口的返回值的格式

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

 

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

   --- 返回值类型

   --- 返回值定义的名称

 

 

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

 

 

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

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

 

 

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

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

 

相关文章
|
Ubuntu
百度搜索:蓝易云【Ubuntu(14/18)Swap分区设置】
完成以上步骤后,你的Ubuntu系统就会配置好Swap分区,可以提供额外的内存支持。请注意,这些步骤适用于Ubuntu 14.04和18.04版本。
444 2
|
11月前
|
存储 缓存 物联网
MNN推理框架将大模型放进移动端设备,并达到SOTA推理性能!
随着移动端(手机/平板等)算力、内存、磁盘空间的不断增长,在移动端部署大模型逐渐成为可能。在端侧运行大模型,可以有一系列好处:去除网络延迟,加快响应速度;降低算力成本,便于大规模应用;不需数据上传,保护用户稳私。
1960 13
MNN推理框架将大模型放进移动端设备,并达到SOTA推理性能!
|
缓存 运维 关系型数据库
运维角度浅谈MySQL数据库优化
运维角度浅谈MySQL数据库优化
|
存储 人工智能 机器人
生成式 AI 与 LangCHain(一)(4)
生成式 AI 与 LangCHain(一)
730 1
|
运维 监控 数据处理
【天衍系列 03】深入理解Flink的Watermark:实时流处理的时间概念与乱序处理
【天衍系列 03】深入理解Flink的Watermark:实时流处理的时间概念与乱序处理
413 5
|
NoSQL 关系型数据库 MySQL
Percona XtraBackup是否支持Redis数据库备份?
【5月更文挑战第13天】Percona XtraBackup是否支持Redis数据库备份?
168 2
|
消息中间件 存储 NoSQL
【实战】使用Lua脚本怎么清理redis中的数据【实战】使用Lua脚本怎么清理redis中的数据
首先我们通过hiredis 向redis 中写入了数据,这里我们主要以测试为目的,所以,Key 值设定为毫秒级时间戳。
257 0
|
JavaScript Java 测试技术
基于ssm+vue.js+uniapp小程序的儿童教育网站附带文章和源代码设计说明文档ppt
基于ssm+vue.js+uniapp小程序的儿童教育网站附带文章和源代码设计说明文档ppt
145 0
|
前端开发 搜索推荐 容器
《CSS 简易速速上手小册》第1章:CSS 基础入门(2024 最新版)
《CSS 简易速速上手小册》第1章:CSS 基础入门(2024 最新版)
160 0
|
数据库
vue+elementui中,el-select多选下拉列表中,如何同时获取:value和:label的值?
vue+elementui中,el-select多选下拉列表中,如何同时获取:value和:label的值?
1338 0
vue+elementui中,el-select多选下拉列表中,如何同时获取:value和:label的值?