QCon北京「鸿蒙专场」火热来袭!即刻报名,与创新同行~ 了解详情
写点什么

Google 公开了云服务 API 设计指南

  • 2017-03-14
  • 本文字数:741 字

    阅读完需:约 2 分钟

Google 公开了用于创建 HTTP 或 RPC API 的 API 设计指南。对于创建连接 Google Cloud Endpoints 的 gRPC API 的开发人员来说,这些设计原则更值得推荐使用。

早在 2014 年,Google 在创建云服务API 其它服务API 时就开始在内部使用了这些设计指南。指南中探讨了HTTP 或RPC API 的设计。虽然HTTP API(也称为REST API)的优点是公认的,但是它们距离实用尚有时日。Google 推荐RPC 尤其是其变体 gRPC 。据 Google 说,虽然大部分的因特网 API 是 HTTP,但是通常被云服务和服务提供商内部使用的是 RPC,并在数量上远高于 HTTP API。

对于通过方法操作一个或多个资源这样的场景,Google 推荐在设计 RPC API 时使用类 REST 方法。资源(也可称为域实体)使用 URI 表示,也可以在网络路径格式后面加上唯一的名称(ID)。同一类型的资源将组织成同一集合。

使用的标准方法包括CreateDeleteGetListUpdate。对于不能映射到任一标准方法上的操作,例如数据库事务,用户也可以创建自定义方法。推荐使用较少的方法来操作尽可能多的资源。

在创建资源时,推荐执行如下步骤:

  • 确定 API 提供的资源类型。
  • 确定资源间关系。
  • 基于类型和关系确定资源的命名模式。
  • 确定资源模式。
  • 为资源附加最小的方法集。

Google 使用“语义化版本”标准命名版本,命名使用三个数字,形式为“主版本. 次版本. 补丁”。预发布版本在命名时添加了一个前缀,例如“1.0.0-alpha”。

对于资源、标准、自定义方法、标准域、错误、使用proto3 创建API 等方面,指南提供了更多细节和例子。

查看英文原文: Google Makes Public Their API Design Guide


感谢张卫滨对本文的审校。

给InfoQ 中文站投稿或者参与内容翻译工作,请邮件至 editors@cn.infoq.com 。也欢迎大家通过新浪微博( @InfoQ @丁晓昀),微信(微信号: InfoQChina )关注我们。

2017-03-14 19:006107
用户头像

发布了 227 篇内容, 共 77.9 次阅读, 收获喜欢 28 次。

关注

评论

发布
暂无评论
发现更多内容

QCN9024 WiFi 6E Card with ath11k Support Exploring the Versatility

wifi6-yiyi

ath11k

升级鸿蒙NEXT,流畅、安全、便捷,一步到位

最新动态

全国范围AOI数据2024年12月更新,共计超过305万个,最完整的地理要素数据库(AOI数据更新系列)

Geek_f9782a

AOI 全国AOI数据

RAG+Prompt,AI编程从需求到代码

腾讯云代码助手

这个冬天,我们一起升级吧

最新动态

百度联合研究会打造“文心快码”无障碍版本,助力视障开发者就业无“碍”

信息无障碍研究会

产品 程序员、 开发. AI编程 无障碍适配

【体验官招募】SoFlu - JavaAI 开发助手:开启智能开发新时代

飞算JavaAI开发助手

程序员 有奖活动 Java. AI编程

代码人生-精选文章周刊

安全乐谷

互联网 职场 心理学 找工作 招聘

主打一个“小巧灵动”:Vite + Svelte

vivo互联网技术

性能 vite Svelte 研发效率 轻量

不懂代码的人也可以5分钟完成一个简单的支付页面(含使用教程)

腾讯云代码助手

AI算力要变天了?一文搞懂ASIC和GPU

Finovy Cloud

gpu 算力 AI算力 ASIC

鸿蒙Flutter实战:14-现有Flutter 项目支持鸿蒙 II

少湖说

flutter 鸿蒙系统 harmoyos

人工智能与区块链的碰撞:双剑合璧的创新前景

天津汇柏科技有限公司

区块链 AI 人工智能

你不知道的 7 项 CSS 新功能

伤感汤姆布利柏

Cellebrite Inseyets PA 10.4 - 取证数据分析软件

sysin

Inseyets PA

Sora 文生视频技术大揭秘:能力惊艳但局限几何?

测试人

软件测试

「地平线」副总裁余轶南与「理想汽车」智驾产品总监赵哲伦联手创业,入局具身智能赛道!

机器人头条

自动驾驶 人形机器人 具身智能 地平线

平凯星辰亮相开放原子开发者大会,TiDB 荣获年度活跃开源项目奖项

PingCAP

开源 分布式 TiDB 数据库、

如何提升大模型的“深度思维能力”

阿里技术

大模型 大语言模型 思维能力 智能引擎

观测云产品更新 | 自动编写 Pipeline、AI 告警聚合、生成指标优化等

观测云

产品迭代

Google公开了云服务API设计指南_REST_Abel Avram_InfoQ精选文章