API 设计规范一直是个让人很头痛的问题,不同的设计风格会导致同一个公司之间无论是前端浏览器还是后端服务调用不同的实现时产生很多不可预知的情况,维护成本和理解成本还很高。
题主以前是 Rails 开发者,因此对于 API 设计一直倾向于面向资源、标准化方法。 但是在真实的业务场景下,也有很多难以抽象的业务。
无意间看到 Google 的 API Design Guide,发现里面提出了很多比较建设性的观点。网上搜了一下,没有翻译得比较好的版本,因此利用业务时间和几个同事一起把它翻译了,除了可以在公司内部推广以外,也是对自己的设计风格作出规范。
目前应该完善得差不多了,因此决定开源,有兴趣的可以看看,顺便麻烦点个 Star。
GitHub Repo:https://github.com/ch3rub1m/api-design-guide
Gibook 在线文档:https://google-cloud.gitbook.io/api-design-guide/