google api设计指南-简介

简介

这是联网 API 的通用设计指南。它自 2014 年起在 Google 内部使用，是 Google 在设计 Cloud API 和其他 Google API 时遵循的指南。此设计指南在此处共享，以便为外部开发者提供信息，并使我们所有人更容易协同工作。

在设计 gRPC API 时，Google Cloud Endpoints 开发者可能会发现本指南特别有用，我们强烈建议此类开发者使用这些设计原则。但我们不强制要求使用本指南。您可以使用 Cloud Endpoints 和 gRPC，而无需遵循本指南。

本指南适用于 REST API 和 RPC API，尤其适用于 gRPC API。gRPC API 使用 Protocol Buffers 定义其 API 接口和 API 服务配置，以配置其 API 服务，包括 HTTP 映射、日志记录和监控。Google API 和 Cloud Endpoints gRPC API 使用 HTTP 映射功能进行 JSON/HTTP 到 Protocol Buffers/RPC 的转码。

本指南是一份活文档，随着时间的推移，我们会批准并采纳新的风格和设计模式，同时也会为本指南增加相关内容。本着这种精神，我们会一直完善本指南，并为 API 设计提供充足的艺术和工艺发挥空间。

本文档中使用的惯例

本文档中使用的要求级别关键字（“必须”、“不得”、“必需”，“应”、“不应”、“应该”、“不应该”、“建议”、“可以”和“可选”）将按 RFC 2119 中的描述进行解释。

在本文档中，这些关键字使用粗体突出显示。

google api设计指南-简介相关推荐

Google API 设计指南 - 前言
原文地址:https://cloud.google.com/apis... Copyright: Creative Commons Attribution 3.0 License Current Ve ...
Google API 设计指南－设计模式
翻译自 API Design Guide - Design Patterns 空响应体标准的 Delete 方法必须(must) 返回 google.protobuf.Empty 来实现全局一致性 ...
RESTful API 设计指南[转]
一种软件架构风格.设计风格,而不是标准,只是提供了一组设计原则和约束条件.它主要用于客户端和服务器交互类的软件.基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制. RESTful AP ...
组件接口(API)设计指南－文件夹
组件接口(API)设计指南-文件夹组件接口(API)设计指南[1]-要考虑的问题组件接口(API)设计指南[2]-类接口(class interface) 组件接口(API)设计指南[3]-托付( ...
RESTful API 设计指南 (转)
RESTful API 设计指南 2016-02-23 ImportNew (点击上方公号,可快速关注) 作者:阮一峰链接:http://www.ruanyifeng.com/blog/2014/0 ...
RESTful API 设计指南
原文地址:http://www.ruanyifeng.com/blog/2014/05/restful_api.html RESTful API 设计指南作者: 阮一峰日期: 2014年5月22日 ...
服务端指南 | 良好的 API 设计指南
设计一套良好的 API 接口. 原文地址:服务端指南 | 良好的 API 设计指南博客地址:blog.720ui.com/ 版本号在 RESTful API 中,API 接口应该尽量兼容之前的版本 ...
HTTP API 设计指南（基础部分）
为了保证持续和及时的更新,强烈推荐在我的Github上关注该项目,欢迎各位star/fork或者帮助翻译前言这篇指南介绍描述了 HTTP+JSON API 的一种设计模式,最初摘录整理自 Hero ...
Android的Google官方设计指南（上）
Android 设计规范本文章是我公司一个大牛之前的公司同事翻译的Android的Google官方设计指导,经过我整理而成,分享给大家,欢迎转载,但是请保留出处和翻译作者.本指导内容详实.规范,无论 ...

google api设计指南-简介

简介

本文档中使用的惯例

google api设计指南-简介相关推荐

最新文章

热门文章