谷歌API 设计指南

术语库

Preview
  • 网络 API
  • Google API
  • Google Cloud API
  • API 接口
  • API 版本
  • API 方法
  • API 请求
  • API 服务
  • API 标题
  • API 服务名称
  • API 服务端点
  • API 服务定义
  • API 产品
  • API 使用者
  • API 生产者
  • API 后端
  • API 前端

网络 API

  • 跨计算机网络运行的应用编程接口。它们使用包括 HTTP 和 gRPC 在内的各种网络协议进行通信,并且由不同的组织生成,通常供大于求。

Google API

  • Google 服务公开的网络 API。其中大多数都托管在 googleapis.com 域名上。您可以使用 Google Cloud ConsoleService Usage API 发现可用的 Google API。此术语不包括其他类型的 API,例如客户端库和 SDK。 注意:所有 Google API 都共享一个通用的使用模型:API 使用者使用由 API 生产者管理的 API 服务。这样一来,开发者和用户就可以在所有 Google API 中获得简单、一致的体验。

Google Cloud API

  • Google Cloud 服务公开的 Google API 子集。如需了解详情,请参阅 Google Cloud API

API 接口

  • 一个 Protocol Buffers service 定义。它通常映射到大多数编程语言中的某一个接口。API 接口可以由任意数量的 API 服务实现。

API 版本

  • 一个 API 接口或一组 API 接口(如果一起定义)的版本。API 版本通常由字符串(例如“v1”)表示,并显示在 API 请求和 Protocol Buffers 包名称中。

API 方法

  • API 接口中的单个操作。它在 Protocol Buffers 中由 rpc 定义表示,并且通常映射到大多数编程语言的接口中的一个函数。

API 请求

  • API 方法的单个调用。它通常用作计费、日志记录、监控和速率限制的单位。

API 服务

  • 在一个或多个网络地址上公开的一个或多个 API 接口(如 Cloud Pub/Sub API)的部署实现。 注意APIservice 都是软件工程的常用术语。它们在不同语境下的含义也截然不同。强烈建议不要定义它们的含义。对于 Google API,APIservice 都是 Google 提供的 API 服务的简写形式,这些服务列在 Google Cloud Console 中的 API 库下。

API 标题

  • 是指面向用户的 API 服务产品名称,例如“Cloud Pub/Sub API”。

API 服务名称

  • 是指 API 服务的逻辑标识符。Google API 使用符合 RFC 1035 DNS 规范的名称作为其 API 服务名称,例如“pubsub.googleapis.com”。

API 服务端点

  • 是指 API 服务用于响应实际 API 请求的网络地址。示例:https://pubsub.googleapis.comhttps://content-pubsub.googleapis.com。单个服务可以拥有多个端点。

API 服务定义

  • 用于定义 API 服务的 API 接口定义(.proto 文件)和 API 服务配置(.yaml 文件)的组合。 Google API 服务定义的架构为 google.api.Service

API 产品

  • API 服务及相关组件(如服务条款、文档、客户端库和服务支持)将作为一个产品统一呈现给客户。例如,Google Calendar API。人们有时将 API 产品简称为 API。

API 使用者

  • 使用 API 服务的实体。对于 Google API,使用者通常是拥有客户端应用或服务器资源的 Google 项目。

API 生产者

  • 生产 API 服务的实体。对于 Google API,生产者通常是拥有 API 服务的 Google 项目。

API 后端

  • 实现 API 服务业务逻辑的一组服务器及相关基础架构。单个 API 后端服务器通常称为 API 服务器。

API 前端

  • 跨 API 服务提供通用功能(例如负载平衡和身份验证)的一组服务器及相关基础架构。单个 API 前端服务器通常称为 API 代理。 请注意,API 前端和 API 后端运行时可以彼此相邻,也可以离得很远。在某些情况下,它们可以编译为单个应用二进制文件,并在单个进程中运行。