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

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

相关推荐
子兮曰8 小时前
async/await高级模式:async迭代器、错误边界与并发控制
前端·javascript·github
gxp12312 小时前
初学React:请求数据参数未更新 && 数据异步状态更新问题
react.js
柳杉13 小时前
从零打造 AI 全球趋势监测大屏
前端·javascript·aigc
simple_lau13 小时前
Cursor配置MasterGo MCP:一键读取设计稿生成高还原度前端代码
前端·javascript·vue.js
睡不着先生13 小时前
如何设计一个真正可扩展的表单生成器?
前端·javascript·vue.js
进击的尘埃13 小时前
AI 代码审查工具链搭建:用 AST 解析 + LLM 实现自动化 Code Review 的前端工程方案
javascript
juejin_cn13 小时前
[转][译] 从零开始构建 OpenClaw — 第五部分(对话压缩)
javascript
leolee1814 小时前
Redux Toolkit 实战使用指南
前端·react.js·redux
bluceli14 小时前
React Hooks最佳实践:写出优雅高效的组件代码
前端·react.js
ZengLiangYi14 小时前
并发 401 下的 Token 刷新竞态:一个被低估的 Bug
typescript