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

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

相关推荐
bonechips7 分钟前
Tool Use:从"缸中大脑"到 AI Agent 的技术真相
javascript·agent
秋天的一阵风25 分钟前
Vue 3 里被严重低估的 API:InjectionKey
前端·javascript·vue.js
kisshyshy32 分钟前
从递归到迭代,一文吃透二叉树的核心知识与 JavaScript 实现
javascript·算法·代码规范
铁皮饭盒1 小时前
Bun 多线程有多快?postMessage 传输字符串比 Node.js 快 400 倍!
前端·javascript·后端
To_OC11 小时前
LC 49 字母异位词分组:想到哈希表很简单,选对 key 才是精髓
javascript·算法·leetcode
kyriewen14 小时前
用了半年 Claude Code 后,我尝试关掉它写了一周代码——结果比想象中严重
前端·javascript·ai编程
山河木马16 小时前
矩阵专题0-webGL中的矩阵
javascript·webgl·计算机图形学
Asize16 小时前
多模态生图:从 Vite 工程化到前端调用 Qwen Image
javascript·人工智能·后端
陳陈陳16 小时前
从Token到Embedding:一篇文章搞懂大模型的「文字数学变形记」
前端·javascript·ai编程
用户9385156350716 小时前
从 O(n²) 到 O(nlogn):一文读懂快速排序的“快”与“妙”
javascript·算法