Google API 设计指南-词汇表
翻译自 API Design Guide - Glossary
网络 API(Networked APIs)
- 通过计算机网络中运行的应用程序接口。它们使用包括 HTTP 在内的网络协议进行通信,并且生产和消费 API 的往往是不同的组织。
Google API
- Google 服务的网络 API。大部分在
googleapis.com
域名上。不包括客户端库和 SDK 等其他类型的 API。
<span id="interface">API 接口(API Interface)</span>
- 一个 Protocol Buffer 服务的定义。在大多数编程语言中它被映射到一个接口。一个 API 接口可以被多个 API 服务实现。
<!--more-->
<span id="version">API 版本(API Version)</span>
- 一个 API 接口或多个定义在一起的 API 接口的版本。API 版本通常以字符串表示(例如 "v1")并且以 API 请求和 Protocol Buffer 的包名表示。
API 方法(API Method)
- API 接口中的一个单独操作。在 Protocol Buffer 中以
rpc
定义,并且在大多数编程语言中映射到 API 接口中的一个函数。
API 请求(API Request)
- 一个单独的 API 方法调用。它经常用作计费、记录、监控和速率限制的单位。
<span id="service">API 服务(API Service)</span>
- 一人部署了暴露出网络端点的 API 接口的实现。API 服务以 RFC 1035 DNS 格式的服务名(例如
calendar.googleapis.com
)进行标识。
API 端点(API Endpoint)
- 指向用于 API 服务处理实际 API 请求的网络地址。例如
pubsub.googleapis.com
和content-pubsub.googleapis.com
。
API 产品(API Product)
- 一个 API 服务加上相关的组件(服务声明、文档、客户端库和服务支持),组合起来以产品的形式提供给用户。例如 Google Calendar API。注意:人们有时会简单地使用 API 表示 API 产品。
API 服务定义(API Service Definition)
- API 接口的定义(.proto 文件)和 API 服务配置(.yaml 文件)一起定义了API 服务
API 消费者(API Consumer)
- 消费 API 服务的实体。对于 Google API,API 消费者一般是拥有客户端程序或服务端资源的 Google 项目。
API 生产者(API Producer)
- 产生 API 服务的实体。对于 Google API,API 生产者一般是拥有 API 服务的 Google 项目。
API 后端(API Backend)
- 为 API 服务实现了业务逻辑的一组服务和相关的基础设施。
API 前端(API Frontend)
- 通过 API 服务提供通用功能的一组服务和相关的基础设施,例如负载均衡器和认证服务器。注意:API 前端和后端可能距离很近也可能很远。有时它们可能会编译成一个二进制文件并运行在一个进程中。
1.2k 声望
33 粉丝
推荐阅读
译文 | A poor man's API
在 API 日渐流行的年代,越来越多的非技术人员也希望能从 API 的使用中获利,而创建一套成熟的 API 方案需要时间成本和金钱两方面的资源加持。在这个过程中,你需要考虑模型、设计、REST 原则等,而不仅仅是编写...
API7_技术团队赞 2阅读 1.2k
给新人推荐这 6 款 API 测试工具
Postman: Postman 是一个流行的 API 开发和测试工具,提供了丰富的功能,包括请求构建、测试自动化、数据驱动等。用户可以通过 Postman 的界面轻松创建和测试 RESTful API。
圆圆大姐头赞 3阅读 438评论 1
就这些了, 常见 6 款API 文档工具推荐
Swagger: Swagger 是一个开源的 API 文档管理工具,可以通过注解自动生成 API 文档,并提供交互式 UI 和 API 调试功能。 Swagger 支持多种语言和格式,包括 Java、Python、JSON、YAML 等。
圆圆大姐头赞 3阅读 338
马斯克都不懂的 GraphQL,API 网关又能对其如何理解?
上个月马斯克评论 Twitter App 滥用 RPC 后,与一些 Twitter 的技术主管发生了矛盾 —— 直言马斯克不懂技术。那这个马斯克都不懂的 GraphQL 到底是什么?
API7_技术团队赞 1阅读 1.1k
搞懂 API ,地图 API 制作方法分享
选择地图 API 平台:目前市场上有很多地图 API 平台供选择,比如 Google Maps API、百度地图 API、高德地图 API 等,需要根据实际需求选择合适的平台。
圆圆大姐头赞 2阅读 294
最强 Mock 工具,没人反对吧?
在开发过程中,由于后端与前端并行开发,或者前端需要等待后台开发,难以保证对接效率,同时即使用开发好的 API 对接,也有可能一个 API 不通就阻塞了整个软件的对接工作。同时对软件的敏感度也很高,一不小心就...
圆圆大姐头赞 2阅读 189
我总结了一次, API 接口设计原则有这些
结合我多年在 API 行业摸爬滚打的经验,我总结了一下,API 接口设计原则有这几条:接口设计应该简单易用,易于理解和使用;接口设计应该支持多种格式,如JSON、XML等;接口设计应该支持多种请求方式,如GET、POST...
圆圆大姐头赞 1阅读 253
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。