分享 因为工作需要,业余时间和几个同事一起翻译了一下 Google API Design Guide,有需要的可以来看看。

ch3rub1m · 2018年06月14日 · 最后由 robertyu 回复于 2018年06月19日 · 890 次阅读

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/

共收到 5 条回复

支持翻译~

小建议:改进 README,目前的格式太乱了,说明也不够清晰

没有附原文链接

Rei 回复

嗯,谢谢建议,这个Readme其实是谷歌官方的Introduction翻译过来的,我之后会把它放进Introduction章节,然后在新的Readme里放上原文链接

1c7 回复

同上

自定义方法,使用驼峰命名方式?

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册