API编写规范

为什么设计api详情规范

主要是为了保证公司的小伙伴写出的api尽量少出bug，加快研发速度。

api 设计规范

1. 绝大部分api都请务必加入用户id限定，主要为了防止某个用户可以请求所有的数据库数据；

2. 管理员api，必须加入 @Secured(AuthorityConstants.ADMIN) 保证该api只能使用管理员账号才能访问；

3. 所有的api都必须加入严格的参数验证机制，保证参数不合法的时候请求快速报错，减少数据库以及微服务的压力；

4. 所有的api都必须要保证api可以向前兼容，api以增加为主、修改为辅；

5. api控制层，只做参数验证，不做业务逻辑，所有的业务逻辑都应该放到业务层；