开发接口的一般方法1.0

1.梳理业务流

开发接口的第一步是了解接口相关的业务流,明确需求,是否需要改变业务流的逻辑、或因为第三方sdk变化导致版本兼容性等问题。(注意避免jar冲突)

2.确定接口需要的参数

参数的规定让接口开发更加规范,一般接口需要的参数由接口的开发方提供。通过查阅相关文档,获取需要请求的参数。

3.接口开发的必要性

有一些情况下,新增接口本身是无意义的。
如数据源本身的数据内容变化,此时只需要修解析DTO (最好是新创建一个,与旧版本区分开来)就可以了。

4.测试接口

一般简单的接口具有固定期望的输入输出,换句话来说使用postman测试接口是否可用,是否会根据预期返回error code。这很重要,很多时候error code是用来检验接口出错的方法,所以一定要将error code的书写尽量规范。

5.Bug检查

一般来说,出现bug会有以下几种情况

1.服务本身不可用导致调用失败

出现第一种情况时是可用根据http的响应数据来检测出的
一般会响应5xx的错误,此时需要了解一定的http协议

2.参数有误导致调用失败

这种情况细分下来有两种:
一是期望传参类型与实际传参类型不同,导致调用失败
二是传参类型无误,单传参格式与预期不符,导致调用失败,接口应当检查第二种情况并且返回相应的error code

3.程序运行中发生不可预测错误导致错误

程序代码性能低下,内存泄漏导致OOM程序终止

4.代码本身逻辑有问题

如对空字符,空对象没有做判空操作等。。。
5. (待补充)

  • 1
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值