最佳实践 汇总API接口设计的一些常见的最佳实践 安全与升级 1.版本管理 无论是小程序，还是app，还是Web网站，都需要版本升级，而提前设计好版本，可以避免因为升级导致旧的服务无法正常工作。 需要要保证在升级的时候，新旧版本的服务都能正常提供服务。 2.授权认证 大部分接口都是需要授权认证的，因此要对接口的授权认证进行判断，这样可以过滤掉大部分的非法访问。 可以通过token校验实现 3.签名 … 继续阅读
API接口设计(3)：全局规范汇总
回复
月度归档：2021年09月
API接口设计(2)：全局异常处理
背景 接口异常返回信息，属于API接口规范的一部分。如何更高效的处理好异常信息，对于定位和排查问题问题，很有帮助。 全局异常处理原理 SpringBoot中有一个@ControllerAdvice的注解，使用该注解表示开启了全局异常的捕获，只需在自定义一个方法使用ExceptionHandler注解，然后定义捕获异常的类型即可对这些捕获的异常进行统一的处理。 这一部分可以做成一个公共组件，其他项目 … 继续阅读
API接口设计(1)：统一返回数据格式
1.背景 现在的项目绝大部分都采用微服务框架，并采用前后端分离的开发模式，这对前后端的数据通信，提出了要求。 后端返回给前端的数据类型可能会是：基本数据类型、String字符串、对象、数组、或者异常提示等。前端拿到后端返回的数据去展示或者给出错误提示，但前端不可能对每个接口都把这些异常提示处理一遍，比如说返回没有登录、或者一些业务异常、或者其他服务内部异常等。 这属于前后端分离的接口约定和规范问题 … 继续阅读