什么是RESTful API?

本文详细解析了RESTful API的设计原则与规范,包括资源、统一接口、URI及无状态特性,阐述了如何利用HTTP动词进行CRUD操作,以及RESTful API在不同前端与同一后台交互中的应用。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

转载:https://blog.csdn.net/hjc1984117/article/details/77334616

要弄清楚什么是RESTful API,首先要弄清楚什么是REST。REST -- REpresentational State Transfer,英语的直译就是“表现层状态转移”。如果看这个概念,估计没几个人能明白是什么意思。那下面就让我来用一句人话解释一下什么是RESTful:URL定位资源,用HTTP动词(GET,POST,PUT,DELETE)描述操作。

 

     Resource:资源,即数据。
     Representational:某种表现形式,比如用JSON,XML,JPEG等;
     State Transfer:状态变化。通过HTTP动词实现。

 

    所以RESTful API就是REST风格的API。 那么在什么场景下使用RESTful API呢?在当今的互联网应用的前端展示媒介很丰富。有手机、有平板电脑还有PC以及其他的展示媒介。那么这些前端接收到的用户请求统一由一个后台来处理并返回给不同的前端肯定是最科学和最经济的方式,RESTful API就是一套协议来规范多种形式的前端和同一个后台的交互方式。

 

     RESTful API由后台也就是SERVER来提供前端来调用。前端调用API向后台发起HTTP请求,后台响应请求将处理结果反馈给前端。也就是说RESTful 是典型的基于HTTP的协议。那么RESTful API有哪些设计原则和规范呢?

 

     1,资源。首先是弄清楚资源的概念。资源就是网络上的一个实体,一段文本,一张图片或者一首歌曲。资源总是要通过一种载体来反应它的内容。文本可以用TXT,也可以用HTML或者XML、图片可以用JPG格式或者PNG格式,JSON是现在最常用的资源表现形式。

 

     2,统一接口。RESTful风格的数据元操CRUD(create,read,update,delete)分别对应HTTP方法:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源,这样就统一了数据操作的接口。

 

     3,URI。可以用一个URI(统一资源定位符)指向资源,即每个URI都对应一个特定的资源。要获取这个资源访问它的URI就可以,因此URI就成了每一个资源的地址或识别符。一般的,每个资源至少有一个URI与之对应,最典型的URI就是URL。

 

     4,无状态。所谓无状态即所有的资源都可以URI定位,而且这个定位与其他资源无关,也不会因为其他资源的变化而变化。有状态和无状态的区别,举个例子说明一下,例如要查询员工工资的步骤为第一步:登录系统。第二步:进入查询工资的页面。第三步:搜索该员工。第四步:点击姓名查看工资。这样的操作流程就是有状态的,查询工资的每一个步骤都依赖于前一个步骤,只要前置操作不成功,后续操作就无法执行。如果输入一个URL就可以得到指定员工的工资,则这种情况就是无状态的,因为获取工资不依赖于其他资源或状态,且这种情况下,员工工资是一个资源,由一个URL与之对应可以通过HTTP中的GET方法得到资源,这就是典型的RESTful风格。

 

     说了这么多,到底RESTful长什么样子的呢?

GET:http://www.xxx.com/source/id 获取指定ID的某一类资源。例如GET:http://www.xxx.com/friends/123表示获取ID为123的会员的好友列表。如果不加id就表示获取所有会员的好友列表。

POST:http://www.xxx.com/friends/123表示为指定ID为123的会员新增好友。其他的操作类似就不举例了。

 

     RESTful API还有其他一些规范。1:应该将API的版本号放入URL。GET:http://www.xxx.com/v1/friend/123。或者将版本号放在HTTP头信息中。我个人觉得要不要版本号取决于自己开发团队的习惯和业务的需要,不是强制的。2:URL中只能有名词而不能有动词,操作的表达是使用HTTP的动词GET,POST,PUT,DELETEL。URL只标识资源的地址,既然是资源那就是名词了。3:如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。?limit=10:指定返回记录的数量、?page=2&per_page=100:指定第几页,以及每页的记录数。

### Restful API 的定义 Restful API 是一种基于 Representational State Transfer (REST) 原则设计的网络应用程序接口[^1]。它是一种轻量级的通信协议,旨在通过 HTTP 协议来访问和操作资源。这些资源通常被表示为 URI(统一资源标识符),并通过标准的 HTTP 方法(GET、POST、PUT、DELETE 等)来进行操作。 在 RESTful 中,“资源”是一个核心概念,所有的请求都围绕着资源展开。客户端可以通过发送不同的 HTTP 请求方法来获取、创建、更新或删除服务器上的资源[^2]。 --- ### Restful API 的工作原理 Restful API 的工作方式依赖于以下几个关键原则: #### 1. **无状态** 每次请求都需要包含足够的信息以便服务器能够独立处理该请求,而不需要保存任何上下文信息。这意味着服务器不会存储会话的状态信息,从而提高了系统的可伸缩性和可靠性[^3]。 #### 2. **统一接口** 为了简化和标准化系统之间的交互,REST 定义了一组约束条件和架构原则。这包括四个方面的特性: - 资源识别:每个资源都有唯一的 URI 进行标识。 - 动词驱动的操作:使用标准的 HTTP 方法(如 GET 表示读取,POST 表示创建,PUT 表示修改,DELETE 表示删除)对资源进行操作。 - 自描述消息:每条消息都应该包含足够的信息让接收方理解如何处理这条消息,比如 MIME 类型、缓存规则等。 - 超媒体作为应用状态引擎(HATEOAS):响应应该包含指向其他相关资源的链接,使得客户端可以根据当前状态动态发现可用的动作。 #### 3. **分层系统** 允许将架构划分为多个层次结构,每一层只与其相邻的一层发生相互作用。这种设计有助于提高灵活性和安全性,并支持负载均衡器或其他中间件组件的存在。 #### 4. **按需代码(可选)** 虽然不是强制性的,但在某些情况下,服务器可能会向客户端发送可执行代码片段以供临时使用,例如 JavaScript 小程序。这种方式增强了功能扩展的可能性,但也可能带来额外的安全风险。 --- ### 总结 综上所述,Restful API 是一种遵循 REST 架构风格的设计模式,其主要特点是利用 HTTP 协议的标准方法操作远程资源,强调无状态性、统一接口以及清晰的资源划分。这样的设计理念不仅便于开发者理解和实现跨平台调用,还极大地促进了微服务架构的发展与普及。 ```python import requests # 示例:简单的 RESTful API 调用 response = requests.get('https://api.example.com/resource') print(response.json()) ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值