什么是RESTful

简介: RESTful是一种面向资源的API设计规范,强调用统一标准操作资源。它将系统中的数据抽象为资源,通过URI唯一标识,结合HTTP动词(GET/POST/PUT/DELETE)实现增删改查,提升接口的可读性、一致性与可维护性,避免“动词+路径”的混乱设计,使API结构清晰、易于扩展和协作。

为什么需要RESTful
对于http接口的调用,其历程经历过原始servlet,到后面的struts,SpringMVC,对于后端的参数封装也逐渐从单个属性演变成对象封装,然而即使到现在,我们对于http接口的封装,仍有不少公司采用下述示例:
@ApiOperation("执行")
@PostMapping("/execute")
public Result execute(@Valid @RequestBody ExecuteRequest request) {
// 业务逻辑处理...
return Result.success();
}
在这种模式下,开发人员一般将功能(或页面)聚合成一个controller,接口的路径定义也具备行为的特征,如对订单的操作,接口的定义一般形似(如删除、ID查询也可DELETE/GET):
功能 协议 接口 参数
新增 POST /order/save OrderSaveRequest
修改 POST /order/update OrderUpdateRequest
删除 POST /order/delete OrderDeleteRequest
ID查询 POST /order/getById OrderSingletonQueryRequest
复杂查询 POST /order/get OrderQueryRequest
在这种模式下我们对于订单协议的封装存在一个明显的问题:订单这个资源其行为是不规范的,同样是删除,有的人员定义为POST请求,有的是GET请求,资源表现的行为没有一个统一标准。更有甚者甚至会将order的功能封装成多个路径:save/order、save/product,这对于后续协议的维护简直就是灾难级别。因此我们需要一种设计规范,将程序员对于同一资源的行为封装做到规范统一。
总结为RESTful风格的设计拥有以下特点:结构清晰、统一标准、易于理解、扩展方便。
什么是RESTful
Resource Representational State Transfer:资源具象状态传输
RESTful是一个理念,是一个设计规范,而并非什么协议,其主要关键词如下:
资源
在RESTful的理念下,互联网中任意信息都可定义为资源,如上述对于订单的增删改查,在此就抽象为订单资源;资源会对应一个特定的URI,URI为每一个资源的地址或独一无二的标识符,对应订单就可抽象为:http://application/order。此时订单抽象为资源,资源对应唯一的URI,后续对此资源的操作都将遵循此URI。
表现层
针对资源对外输出的展现,这种呈现形式称之为表现层。以为本为例可以对外呈现为:json/xml/html等多种格式。
状态转化
客户端通过访问服务端,进行增删改查操作,从而对资源状态产生变化,这个过程便是:资源的状态转化。以http协议为例(RESTful不仅使用HTTP协议,只不过是经常以HTTP协议为衬托),客户端可通过一些操作让服务端的资源进行变化。整个过程即为:表现层状态转化。而HTTP协议中常见操作方式:GET/POST/PUT/DELETE
如何使用RESTful
资源 GET PUT POST DELETE
一组资源的URI,比如http://example.com/resources/ 列出URI,以及该资源组中每个资源的详细信息(后者可选) 使用给定的一组资源替换当前整组资源 在本组资源中创建/追加一个新的资源。该操作往往返回新资源的URL 删除整组资源
单个资源的URI,比如http://example.com/resources/142 获取指定的资源的详细信息,格式可以自选一个合适的网络媒体类型(比如:XML、JSON等) 替换/创建指定的资源。并将其追加到相应的资源组中。 把指定的资源当做一个资源组,并在其下创建/追加一个新的元素,使其隶属于当前资源。 删除指定资源
RESTful使用进阶
上面对于RESTful的理解和使用我们有了一个认知,但是如果不能在涉及之初就对资源进行合理的划分,RESTful将变成只是针对现有功能的包路径调整。因此我们最好可以在设计之初就引入对应的资源概念。
1.架构中引入资源(Resource)的概念
最常见的错误就是在URI中包含动词,比如URI=http://example.com/getOrder?orderId=1234,其实「资源」表示一种实体,所以应该是名词,动词应该放在HTTP协议中。而与此同时URI也有可能破坏HTTP GET的安全性和幕等性,比如某个客户端在http://example.com/updateOrder?id=1234&coffee=latte上执行GET(而不是POST),就能创建一笔新的咖啡订单(一个资源),按理来说GET请求不能改变服务的任何状态。
2.每一个URI代表一种资源,支持HTTP动词
此时使用多个URI的话,需要让不同的URI代表不同的资源(多个URI可能指向同一个Resource,而一个URI不能指向不同Resource),同时使用多个HTTP方法操作这些资源,例如使用POST/GET/PUT/DELET分别进行CRUD操作。这时候HTTP头和有效载荷都包含业务逻辑,例如HTTP方法对应CRUD操作,HTTP状态码对应操作结果的状态。我们现在看到的大多数所谓RESTful API做到的也就是这个级别。

相关文章
|
9月前
|
SQL 安全 关系型数据库
了解SQL注入
SQL注入是通过恶意构造输入数据篡改数据库查询的攻击方式,可导致身份绕过、数据泄露、篡改甚至远程命令执行。其成因在于应用对用户输入验证不足,攻击者利用特殊字符改变SQL逻辑。OWASP将其列为头号Web威胁。防御需结合白名单验证、参数化查询、错误信息屏蔽及网络层防护如IPS,确保数据与代码分离,杜绝注入可能。(238字)
|
6月前
|
数据采集 监控 Java
详解MES系统生产管理模块,基于java的MES系统源码
MES系统是连接ERP与工业控制系统的桥梁,聚焦生产管理核心,涵盖计划调度、过程监控、质量追溯、物料流转、资源管理和数据采集六大功能,实现生产透明化、精细化与可追溯,赋能制造企业数字化转型。
491 0
|
uml
Confluence插件推荐
Confluence插件推荐
2113 0
|
19天前
|
缓存 人工智能 自然语言处理
阿里云qwen-max、qwen-plus、qwen-flash、qwen-long热门模型解析与模型选择指南
本文全面解析阿里云百炼通义千问四大产品线:qwen-max旗舰、qwen-plus均衡、qwen-flash轻量、qwen-long长文本专用,覆盖全代际版本特性、适用场景、能力参数与价格体系。文章给出四步选型逻辑与生产环境分层调度策略,搭配当前限时折扣、夜间错峰优惠、新人免费额度等活动,帮助开发者精准匹配业务需求,在保障推理效果的同时最大化控制调用成本。
|
9月前
|
SpringCloudAlibaba Java Nacos
SpringCloud概述
Spring Cloud是Spring推出的微服务统一解决方案,弥补了各技术分散的不足,具备约定优于配置、组件丰富、开箱即用等特点。通过伦敦地铁站命名版本,避免与子项目版本冲突。Spring Cloud Alibaba融合阿里开源组件(如Nacos、Sentinel、Seata等),提供完整微服务生态,因Netflix组件停更,现成为主流选择。本节介绍其诞生背景、版本机制及技术体系,为后续实战奠定基础。
|
5月前
|
人工智能 安全 数据中心
DeepSeek V4炸场背后:硅谷在“造墙”,中国在“修路”
4月24日,DeepSeek-V4发布即登顶Hugging Face开源榜,以百万级上下文、极低KV Cache及国产芯片深度适配惊艳业界;同期Kimi K2.6紧随其后。中美AI路径分野凸显:硅谷闭源互搏,中国开源协同——技术共享、架构互鉴、生态共荣,走出一条“和而不同”的AGI新路。
416 0
|
人工智能 开发者
通义千问三款主力模型再降价,最高降幅85%
通义千问三款主力模型再降价,最高降幅85%
9961 12
通义千问三款主力模型再降价,最高降幅85%
|
9月前
|
JSON API 数据库
如何写好一篇技术方案
本模板用于规范产品需求文档,涵盖项目背景、变更记录、功能模块、流程图、API设计等内容,支持语雀卡片与文件附件,提升团队协作效率。
|
9月前
|
容灾 关系型数据库 Nacos
Seata的部署和集成
本文介绍Seata分布式事务TC服务的部署与微服务集成步骤。包括下载、配置、数据库表初始化,通过Nacos实现配置共享与注册,搭建高可用集群,并实现异地容灾。微服务通过统一配置中心动态映射事务组,提升系统灵活性与可靠性。(239字)
|
资源调度 算法 数据可视化
t_SNE 非线性降维基础原理
本文记录了个人关于 非线性降维算法 t-SNE(t-Distributed Stochastic Neighbor Embedding)的学习理解,以供参考学习
1109 0

热门文章

最新文章