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

我们在写接口请求的时候,前端参数是很多的,而且还不确定此时我们有不同的写法,大家都知道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飘红等提示非常有用,可以大大提高开发效率

相关推荐
青咕咕12 小时前
REACT系列 3、性能优化
react.js
小高00713 小时前
深入理解 package.json:前端项目的 "身份证"
前端·javascript·vue.js
lichenyang45313 小时前
Next.js 学习笔记:从约定式路由到 Tailwind、Image、Font 优雅整合。
前端·javascript·全栈
修罗-zero14 小时前
vue在获取某一个div的大小,怎么确保div渲染好,内容撑开后才去获取大小
前端·javascript·vue.js
zhougl99614 小时前
NoSQL 数据库和内存数据库 - MongoDB简单了解
java·前端·javascript
爱学习的马喽14 小时前
React钩子函数完全指南:从useState到useEffect的实战详解与场景剖析
前端·javascript·react.js
JamSlade14 小时前
SSO登录验证设计要点细节(以微软 Microsoft SSO为例) 基于react python
python·react.js·microsoft
abigale0314 小时前
开发实战 - ego商城 - 7 地址管理模块
前端·uni-app·node.js
SamsongSSS14 小时前
JavaScript逆向Vue处理事件和捕获错误的核心逻辑
前端·javascript·vue.js·逆向
码银14 小时前
【简易聊天室】使用 HTML、CSS、JavaScript 结合 WebSocket 技术实现
javascript·css·node.js·html