接口服务正规化

一个好的后台接口,需要注意的细节:
1 接口名称:动词+名词 简洁明了,基本能说明接口的功能。
2 接口注释:功能+作者+时间+出入参数
3 接口参数:定义清晰、规范定义(驼峰)、简单明了,尽量直观能表示其含义。
4 接口逻辑:
(1)入参参数的非空判断
(2)入参参数格式校验(类型:正则校验、枚举校验、数据字典校验、大小写校验、业务数据校验等。)
(3)接口业务逻辑代码
数据库交互(主意单个事物、整个服务类型事物的关系)、第三方接口交互、内部接口交互等略
(4)出参,result(泛型:业务参数,根据业务诉求合理设计业务参数)、status(状态码)、msg(信息提示,场景覆盖全)、success(布尔类型,成功标识)。
5 注释:接口分层次注释,声明每个私有方法的作用,简洁明了。
6 日志:接口出入口日志标识、异常日志信息、可展示的业务数据日志等(日志级别遵照基本原则和项目组对日志级别的要求)。
7 接口参数格式、协议、权限等都遵照项目组的规定来处理。

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值