java接口编写规则

标题服务方

  1. 所有接口提供统一入口,不同接口传递不同参数。
    优点:便于控制请求参数和返回结果;
    既然写了接口,还需要写一个接口查询功能。记录接口的信息:请求参数,请求结果,成功还是失败,失败原因。方便查询。否则,如果没有这个功能,到后面每次失败都要去查日志。
  2. 接口所有字段定义为一个dto对象。
    优点:整个接口有哪些字段,什么类型,是否为必填,什么含义,一目了然。并且方便验证。

消费方

  1. 接口调用使用一个入口。
    优点:方便控制;

  2. 所有请求参数创建为1个dto对象(比如:UserInfoAddRequestDto),同上面的第二点。所有请求参数创建为1个dto对象,同上面的第二点。

  3. xx

总结

  1. 把接口的所有有共通的代码,全部提取出来。方便统一管理,代码整洁。
  • 6
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值