首页   注册   登录
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX  ›  程序员

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

  •  
  •   ch3rub1m · 11 天前 · 1021 次点击

    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/

    谢谢大家。

    9 回复  |  直到 2018-06-14 22:25:21 +08:00
        1
    zynlp   11 天前 via iPhone
    刚好最近在学习 rpc,支持一个
        2
    my3157   11 天前
    已 star
        3
    sulinehk   11 天前 via Android
    mark
        4
    somebody   11 天前 via Android
    已 star,建议把帖子里的话整理一下,发在 github 的 readme 里,另外还有原始链接
        5
    ch3rub1m   11 天前
    @zynlp 谢谢,最近 gRPC 写得比较多,这个 design guide 里也有不少针对 gRPC 的内容,等我再熟悉一些的时候打算写一个 gRPC 的教程
        6
    ch3rub1m   11 天前
    @my3157
    @sulinehk
    感谢
        7
    ch3rub1m   11 天前
    @somebody 嗯,谢谢建议。这个 Readme 其实是谷歌官方的 Introduction 翻译过来的,我之后会把它放进 Introduction 章节,然后在新的 Readme 里放上原文链接
        8
    nVoxel   11 天前 via Android
    好!
        9
    Ge4Los   11 天前
    非常不错,之前是翻看的英文版。
    关于   ·   FAQ   ·   API   ·   我们的愿景   ·   广告投放   ·   鸣谢   ·   1115 人在线   最高记录 3541   ·  
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.1 · 15ms · UTC 17:15 · PVG 01:15 · LAX 10:15 · JFK 13:15
    ♥ Do have faith in what you're doing.
    沪ICP备16043287号-1