解析REST API与OpenAPI之差异：避免混淆

在网络API领域，常提及的两种术语为Rest API与Open API，其既存在差异亦存在联系。前者是一种API设计方式，后者则是一种API描述及定义规范。值得注意的是，OpenAPI 可用于描述和定义REST API。

什么是REST API？

REST API 是一种符合 REST 的设计原则或具象状态传输架构风格的 API，又称为RESTful API。简单的说，REST就是客户端按照约定向服务端请求指定数据、或者在服务端保存数据，服务端响应客户端请求的过程。

注：更多REST API概念的辨析，请阅读 REST API常见问题。

什么是OpenAPI？

OpenAPI 是规范化描述 API 领域应用最广泛的行业标准，由 OpenAPI Initiative 组织定义并维护，同时也是 Linux 基金会下的一个开源项目。它使用规定的格式来描述 HTTP RESTful API 的定义，以此来规范 RESTful 服务开发过程。使用 JSON 或 YAML 来描述一个标准的、与编程语言无关的 HTTP API 接口。

诞生过多种 API描述规范，最终OpenAPI赢得了事实上的胜利。

它们的区别？

• 本质区别：
  OpenAPI是一种API描述 规范，而RESTful API是一种 RPC软件架构风格。
• 功能区别：
  OpenAPI用于描述和定义API的结构和规范，提供了一种标准化的方式来定义API的结构和行为，以便开发者和工具能够理解和使用API。
  而RESTful API是一种设计API的方法和原则。

它们的关联？

REST API与OpenAPI的关系，类似SOAP API与WSDL的关系，是API架构与API描述规范的关系。OpenAPI描述规范 为REST API on HTTP提供了一个正式的标准，它使用YAML或JSON格式，描述API的路径、参数、请求和响应的结构、错误码等信息。

通过API描述规范，可以执行以下自动化行为：

• 1、生成库以方便使用 REST API
• 2、验证并测试使用 REST API 的集成
• 3、使用第三方 API设计工具 探索 API 并与之交互。

参考资料

OpenAPI 描述规范3.0

本文由 mdnice 多平台发布