接口入参的两中不同定义方法优缺点

我们在写接口请求的时候,前端参数是很多的,而且还不确定此时我们有不同的写法,大家都知道typescript(简称ts)出来后,很多人也在使用,它有严格的类型校验,同时写的时候也会相对耗时间,因为每个参数都要写的,相当于把接口文档参数全写了一遍,但是如果为了后续接口改动,尽量少改动 ,也可以用兼容性的写法

1、如下的第一种,定义了具体的入参
优点:1、接口所有参数等一目了然

2、方便维护,遇到问题更便于定位

缺点:1、 相对来说,写代码更费时间一点,因为要写各种数据及类型定义,tsx中使用到也要去引入保持一致

2、虽然是用的ts,但是相当于没有很好地使用ts类型

2、第二种则没有定义具体的类型,只定义了key是string,然后值可以是任意类型,相当于没有校验入参值的类型,

优点:这种以后接口加减参数,这里不用改动,只要调用时传递对应的参数即可

缺点:1、 没有做严格的数据校验,如果参数类型问题(如:number 、string等接收参数类型问题,)参数多的话,不好定位,或者一些内部数据类型转换报错也不好定位

2、 别人看代码,无法知道这个接口要传递什么参数,需要查看接口文档才可以,相对来说,如果接口文档没有及时更新,后续不好维护,接口依赖于接口文档

总结:(1)如果用ts,建议尽量把参数写具体,便于以后维护
(2)可以引入eslint,让代码更健壮

(3)强烈建议在vscode装一个fittencode插件,对ts飘红等提示非常有用,可以大大提高开发效率

相关推荐
闭上眼让寒冷退却4 小时前
知识库发布按钮引发的查询版本发布状态(轮询?——>调用后端接口)以及api接口设计学习
java·前端·javascript
sleeppingfrog4 小时前
konva实现canvas画图基础版本
前端·javascript·css
GISer_Jing4 小时前
Taro+React跨端开发实战指南
react.js·arcgis·taro
jingling5554 小时前
Mark3D | 用 Mars3D 实现一个炫酷的三维地图
前端·javascript·3d·前端框架·html
前端白袍4 小时前
Vue:如何实现日志导出下载功能?
javascript·vue.js·ecmascript
Y‍waiX‍‍‮‪‎⁠‌‫‎‌‫‬4 小时前
【npm】从零到一基于Vite+vue3制作自己的Vue3项目基础的npm包并发布npm
前端·npm·node.js
2503_928411565 小时前
12.18 中后台项目-权限管理
前端·javascript·数据库
elangyipi1235 小时前
pnpm 深度解析:下一代包管理工具的原理与实践
npm·node.js
Y‍waiX‍‍‮‪‎⁠‌‫‎‌‫‬5 小时前
NRM-NPM的镜像源管理工具使用方法
前端·npm·node.js
hssfscv5 小时前
JAVAweb学习笔记——JS
javascript·笔记·学习