看到 API 你会想起什么？

╰半夏微凉° 2021-07-31 21:25 321阅读 0赞

点击上方**蓝色字体**，选择“标星公众号”

优质文章，第一时间送达

![640?wx\_fmt=jpeg][640_wx_fmt_jpeg]

来自 | 谭朝红

链接 | https://www.ramostear.com

看到 API 你会想起什么？是接口、第三方调用、还是API文档？初看你可能会觉得这太熟悉了，这不是系统开发日常系列吗？但你仔细想一想，你会发现 API 的概念在你脑海里是如此的模糊。如何你通过搜索引擎检索API，你会看到类似这样的信息：API——Application Programming Interface(应用程序编程接口)，这太抽象了。接下来，我将结合在开发中总结的一些经验，以通俗的方式聊聊API、REST API、RESTful API以及Web Service这四者之间的联系与区别。

![640][]

## **1、API 与 REST API** ##

什么是API?这里引述维基百科给出的定义：应用程序接口（英语：Application Programming Interface，缩写：API；又称为应用编程接口）是软件系统不同组成部分衔接的约定。这个对API的定义太过于广泛和抽象，而通俗的讲，API是一段应用程序与另一段应用程序相互“交流”的方式（协议）。在Web应用程开发中，API是我们通过网络进行数据检索的一种主要方式，API文档将告知你检索数据的URL列表、查询参数、请求方式以及响应状态，其目的是降低Web应用程序开发难度，共享两个应用程序之间的数据（文本、音频、视频、图片等），而屏蔽其内部复杂的实现细节。

REST是Representational State Transfer的缩写，直译过来就是：表述状态的转移。REST API是一组关于如何构建Web应用程序API的架构规则、标准或指导，或者说REST API是遵循API原则的一种架构风格。REST是专门针对Web应用程序而设计的，其目的在于降低开发的复杂度，提高系统的可伸缩性。下面是设计REST风格的系统架构时需要满足或者遵循的一些基本条件和原则：

1、在REST架构中，Web中所有的事物（文本、音频、视频、图片、链接）都可以被统一的抽象为资源（resource）

2、在REST架构中，每一个资源都有与之对应的唯一资源标识符（resource identifier）,当资源的状态发生改变时,资源标识符不会发生改变

3、在REST架构中，所有的操作都是无状态的。

REST架构遵循CRUD原则，所有的资源都可以通过GET、POST、PUT和DELETE这四种行为完成对应的操作。

4、可缓存（可选项），在REST架构中需要缓存来有效的处理大批量的请求

5、接口一致

现在，了解了API和REST API的基本概念，那这两者之间有什么异同？如果按照数学上集合的概念来解释API与REST API之间的联系与区别，API是REST API的超集，REST API 是API的子集；所有的REST API都是API，但不是所有的API都是REST API。更通俗的解释是：所有的男人都是人，但不是所有的人都是男人。

## **2、REST API 与RESTful API** ##

在第一小节中，了解了什么是REST API，接下来聊聊REST API与RESTful API之间的异同。很多初学者很容易将这两者等同起来，认为RESTful API就是REST API，这可能是单纯的从字面上去理解了，当你深入的去了解两者的本质后，你会发现其实不然 。 欢迎关注公众号： Web项目聚集地  获取更多技术博文

REST API是Web API设计的一种规范或者指导原则，而RESTful API则是这中架构设计原则或者规范的一种具体实现方式。也就是说，RESTful API是REST API的非正式实现方式，因为实现REST API的方式有很多，RESTful API只是其中一种，且没有完全满足REST API的所有设计原则，每个开发者在实现REST 架构时的则重点都会有差别。

很多初学者容易将REST API与RESTful API两者的概念搞混淆，我想可能只是看字面意思，而没有关注它们本身的含义（就像认识中文字一样，有边读边，无边读中间，断章取义了）。这就好比很多人会把变性人等同于女人，变性人可能五官的表象看起来和女人一样，但变性人不能生育，它只是满足了定义一个女性的大多数条件（实现），但本质上不是女人。

接下来，通过一个简单的例子以加深对REST API和RESTful API的理解。下面将给出一个执行CURD操作的RESTful API设计案例：

![640][640 1]

说明：resource代指某种资源的名称，可以时student(学生)、teacher(老师)、book(书籍)等等，通常使用名词来表示；\{id\}则代指某种资源的唯一标识符（resource identifier）

下面是一个具体的小例子，以学生管理为例，设计学生管理的API。学生资源包括ID，姓名和所学课程信息，学生资源信息如下：

![640][640 2]

现在，我们需要将学生数据保存到数据库，然后执行查询、修改和删除学生数据的操作。学生管理API的使用者调用的API如下：

1、创建学生资源：

\[POST\] http://www.example.com/student

2、获取所有学生资源：

\[GET\] http://www.example.com/students

3、获取ID=1001的学生资源：

\[GET\] http://www.example.com/student/1001

4、修改ID=1001的学生资源：

\[PUT\] http://www.example.com/student/1001

5、删除ID=1001的学生资源：

\[DELETE\] http://www.example.com/student/1001

前面的内容说到，API共享数据资源，而屏蔽内部实现，API的使用者（客户端）关注的是资源（读懂数据）,并不需要了解API内部构造;API的提供者（服务端）只关注自己的内部实现，而不关系API使用者（客户端）的状态。为了加深对这一概念的理解，下面给出学生管理API的内部实现示例：

![640][640 3]

除了上述的内容之外，你还可以通过提供键值对的方式对查询数据进行过滤，如获取所有的学生数据时，只想获取性别为女性的学生数据，则可以通过这样的方式来完成：

[GET] http://www.example.com/students?gender=female

Tip：如果API拥有对数据过滤的功能，对应服务端的API实现代码也需要做调整。

在前面的内容中，我们提到RESTful API是REST API的非正式实现方式或规范。为什么这么说呢？因为在RESTful API的设计中，我们完全可以通过GET的方式完成CURD操作，也可以通过DELETE行为来创建资源，通过POST行为来修改资源，它的实现方式并不严谨或者说并没有严格按照REST API提出的约束条件来进行。所以说  **RESTful API是REST API的非正式实现方式**。

## **3、REST与Web Service** ##

### **3-1、什么是 Web Service?** ###

如万维网联盟（W3C）所述，Web Service提供了在各种平台和/或框架上运行的不同软件应用程序之间可以进行互操作的标准方法。Web Service的特点是具有良好的互操作性和可扩展性，以及由于使用XML而可以对程序处理过程进行描述。它们可以以松散耦合的方式组合不同的服务以实现复杂的操作。提供简单服务的程序可以通过相互交互，以提供复杂的增值服务。

两个Web Service之间主要通过HTTP网络协议进行通信，如我们熟知的SOA(面向服务的体系架构)，主要依赖于XML-RPC和SOAP(Simple Object Access Protocol，即简单对象访问协议)。

> Tip：千万不要将SOA（面向服务体系架构）和SOAP(简单对象访问协议)搞混，前者是一种架构设计形式，后者是一种数据交换协议。

简单的一个示例：假设一个Web Service A提供允许其他应用程序通过URL获取用户信息的功能：\[GET\] http://www.abc.com/\{id\}。id是用户的唯一标识符，请求此URL将获得用户信息。现在假设浏览器、手机、桌面应用程序的用户都要获取服务A提供的用户信息，这三者只需要请求服务A提供的URL地址，并输入用户id信息即可。至于者三个不同客户端的实现方式（编程语言）是什么与服务A 没有任何关系，只要能够解析出服务A返回的XML文档即可。这样，应用程序之间交换数据就可以不用依赖于具体的语言和环境。这就好比不同国家不同语言的人，只要能够知晓对方语言的语法结构，两个人就可以进行交流。

### **3-2、Web Service的优点** ###

使用Web Service有如下的几个优点：

1、互操作性：

Web Service允许应用程序之间进行通信，交换数据和共享服务。

2、可用性：

Web Service的功能可以从简单的信息查找到复杂的算法计算。

3、可重用性：

Web Service之间可以相互组合，以提供更为复杂的服务，由于其互操作性的特点，可以轻松的在其他的服务中重用Web Service组件,提高了服务的重用率。

4、易于部署：

Web Service可以部署在基于Internet标准的容器中，如Apache、Axis2等，以提供HTTP或者WSDL（网络服务定义语言）驱动的服务。

5、成本低：

Web Service是通过打包成Web服务组件进行部署，从而降低了使用的成本。

### **3-3、Web Service的类型** ###

目前，Web Service主要有两大流派：

1、基于SOAP的Web Service : **SOAP**(简单对象访问协议)是一种基于XML的协议，用以访问Web Service。

其接口以机器可处理的格式进行描述，称为WSDL(Web服务定义语言)文档。

通过使用标准的的XML文档来描述Web Service，在XML文件中，会详细记录接口的信息，如消息的格式、传输协议以及交互的位置等信息。

2、基于REST的Web Service ：

REST(Representational State Transfer)是一种软件架构，它使用JSON来描述数据格式，最重要的是HTTP传输协议对REST来说是非必须的。

### **3-4、REST与SOAP的区别和联系** ###

下面，通过一张表格来对比REST与SOAP之间的异同：

![640][640 4]

## **总结** ##

如上所述，我们了解了什么是API，什么是REST API,什么是RESTful API以及Web Service的相关概念。API代表应用程序编程接口，是一种较为宽泛的定义或者说是一种协议，作为软件程序之间相互通信的接口而存在。REST API是API的一个子集，所有的REST API都是API；RESTful API是对REST API架构风格的一种非正式实现方式。API与Web Service都是服务提供者和服务消费者之间的通信手段。最后，为了能够快速的识别API与Web Service之间的差异，将这两种手段的不同之处整理成对照表如下：

![640][640 5]

如果喜欢本篇文章，欢迎 转发、点赞 。关注订阅号「Web项目聚集地」，回复「全栈」即可获取 2019 年最新 Java、Python、前端学习视频资源。

--------------------