首页 > 其他 > 详细

本人认为的接口设计原则(欢迎拍砖)

时间:2020-07-21 00:08:04      阅读:68      评论:0      收藏:0      [点我收藏+]

代码层面

  规范的接口名称;规范的出入参名称;

  明确的查询参数;明确的分页参数;严格的参数验证;

  单一职责,确定本接口的业务边界;

安全层面

  请求次数限制;请求数据限制;请求时间时间;

  请求鉴权;

业务层面

  明确本接口新增的业务含义;版本升级兼容;

  是否需要幂等;是否需要加上监控;

  是否满足性能要求;返回的数据是否满足业务的时效要求;

文档方面

  准确的文档说明;及时的文档更新;样例数据的提供;

  完善的状态码描述;

本人认为的接口设计原则(欢迎拍砖)

原文:https://www.cnblogs.com/brave-rocker/p/13347339.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!