写一个接口要注意的原则

1, 参数的含义以及是否自己处理

1.1,弄懂每个字段的含义是什么?不要认为自己是代理一个接口,是调别人接口的中间者,就只负责调通别人接口,而不管不去搞懂每个字段到底啥意思

1.2,遵循接口最小化原则:https://www.csdn.net/tags/NtzaAgwsODg1MjMtYmxvZwO0O0OO0O0O.html
 	也就是这个需求中 变化的参数前端传过来,但是一些字段是固定的值,在这个需求中是固定的值,不会变化的,那就不要前端传过来了。

接口设计六大原则:https://blog.csdn.net/QuietThinking/article/details/117447372

2,异常的处理
要想到各种异常情况,并询问产品这种异常情况怎么处理?
不要自己默默处理掉了,认为这些都不需要问。
比如调别人接口,返回值为空,后端怎么返回,前端怎么处理展示这种情况?
3,返回值的处理
总结: 不要写hashmap(除非一看就知道这个hashmap里放的key是啥含义),写一个类,这样代码才有可读性。

具体场景和解释: 本来是返回比例,我就想着放在hashmap中就可以。

但是把返回值放在hashmap中,代码可读性不高,也就是不知道这个返回值是啥意思。
所以最好还是定义一个VO,把返回值都定义成VO的属性,这样每个属性都有注释,就知道这些返回值啥意思了,可读性就高了。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值