API 设计规范一直是个让人很头痛的问题,不同的设计风格会导致同一个公司之间无论是前端浏览器还是后端服务调用不同的实现时产生很多不可预知的情况,维护成本和理解成本还很高。
题主以前是 Rails 开发者,因此对于 API 设计一直倾向于面向资源、标准化方法。 但是在真实的业务场景下,也有很多难以抽象的业务。
无意间看到 Google 的 API Design Guide,发现里面提出了很多比较建设性的观点。网上搜了一下,没有翻译得比较好的版本,因此利用业务时间和几个同事一起把它翻译了,本次翻译经过了两轮翻译,并最后核对,尽量做到了信达雅。
除了可以在公司内部推广以外,也是对自己的 API 设计风格的总结。
目前应该完善得差不多了,因此决定开源,有兴趣的可以看看,顺便麻烦点个 Star。
GitHub Repo: https://github.com/ch3rub1m/api-design-guide
Gibook 在线文档: https://google-cloud.gitbook.io/api-design-guide/
谢谢大家。
这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。
V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.