介绍Google API Design Guide 是 Google 设计 Cloud APIs 和其他 Google APIs 的设计指南。该指南面向的不仅仅是 REST APIs,同时也适用于 RPC APIs,其中 RPC APIs 主要面向的是 gRPC APIs。面向资源的设计传统…
尽管HTTP REST API在互联网领域已经很流行了,但其承载的流量还是比传统的RPC API小。比如,在高峰期,美国大约一半的互联网流量都是视频内容,出于性能上的考虑,很少有人用REST API。在数据中心内部,更多的公司也使用基于socket的RPC API来承载大多数网络流量,这比REST API的数量高出几个量级。 事实上,RPC API和HT...
在互联网领域,HTTP REST API最近获得了巨大的成功。截至2010年,大约74%的公网API都是HTTP REST API。 尽管HTTP REST API在互联网领域已经很流行了,但其承载的流量还是比传统的RPC API小。比如,在高峰期,美国大约一半的互联网流量都是视频内容,出于性能上的考虑,很少有人用REST API。在数据中心内部,更多的公司也...
GoogleAPIDesignGuide（⾕歌API设计指南）中⽂版 ⾯向资源的设计 这份设计指南的⽬标是帮助开发⼈员设计简单、⼀致、易⽤的⽹络API。同时，它也有助于收敛基于socket的API和（注：原⽂是with，这⾥翻译为“和”）基于HTTP的REST API。以前，⼈们根据诸如CORBA和Windows COM这样的API接⼝和⽅...
本章阐述标准方法的概念,包括了List,Get,Create,Update, andDelete。很多不同类型的API都拥有非常类似的语义,把它们归纳为标准方法能够显著降低复杂度并提高一致性。在谷歌API仓库中,超过70%的API属于标准方法。标准方法更容易学习和使用。 以下表格描述了如何将标准方法映射为REST方法,也就是所谓的CRUD方法: ...
这份指南既适用于REST API也适用于RPC API,并重点关注gRPC API。gRPC API使用Protocol Buffer定义API接口,并使用API Service Configuration去配置API服务,包括HTTP映射,日志和监控。Google API和gRPC Cloud Endpoint API使用HTTP映射特性用把JSON/HTTP转码到Protocal Buffer和RPC。
当使用REST API访问资源时,必须要将资源名称转化为对应的REST URL。这个过程通常包含在服务名前增加HTTPS scheme,在资源名路径前增加API的主版本号并且将资源路径使用URL escape的方式进行编码。例如资源名//calendar.googleapis.com/users/johnsmith/events/123相应的URL则可能是https://calendar.googleapis.com/v3/...
Google API 设计指南-设计模式 翻译自API Design Guide - Design Patterns 空响应体 标准的Delete方法必须(must)返回google.protobuf.Empty来实现全局一致性。它还可以防止客户端依赖于在重试期间不可用的附加元数据。因为随着时间推移对于自定义方法, 对于自定义方法,它们必须(must)具有自己的XxxResponse消息,即使它们...
翻译自API Design Guide 介绍 这是一篇网络 API 的通用设计指南,它从2014年开始被 Google 使用,并且指导我们设计了Cloud API和其它Google API。我们将此指南分享出来希望能让人们更便捷地合作。 Google Cloud Endpoints的开发者在设计gRPC API时可能会发现这篇指南特别有用,我们强烈推荐这类开发者使用这些设计原则,但...
指南中探讨了 HTTP 或 RPC API 的设计。虽然 HTTP API(也称为 REST API)的优点是公认的,但是它们距离实用尚有时日。Google 推荐 RPC 尤其是其变体 gRPC。据 Google 说,虽然大部分的因特网 API 是 HTTP,但是通常被云服务和服务提供商内部使用的是 RPC,并在数量上远高于 HTTP API。