你真的会写Restful API吗?

简介: 你真的会写Restful API吗?

现在服务端向前端暴露的API一般都称自己为Restful API,肉眼可见的最明显特征就是application/json。但是json这个东西只能说是一个数据格式,它的好处就是表达数据清晰简单,但是要把restful和json画个等号就大错特错了。

也许你听说过Rest是面向资源的,但没有这样认真实践过,不知道怎样做才是最符合标准的。其实Rest有一个成熟度模型,最高的等级是超媒体控制,这有个专业的名词:HATEOAS(The Hypermedia As The Engine Of Application Statue)。如果你使用Java,可能看到过Spring HATEOAS,它就是用来实现这个最高等级的,不过用的人应该不多,这是为什么呢?下面会谈到这个问题。

我们先看一下成熟度模型的其它几个等级:

第0级:仅使用http作为通道。

我看见的很多API都停留在这个阶段,接口的形式还是RPC的形式,典型的特征就是get、set、add、delete等命名的接口满天飞,在这些接口中看不到任何基于资源的影子。get和post方法也是混用的,哪个方便用哪个。

第1级:以资源为中心。

我认为做到这一点才算真正的是Restful API了。形式如下:


作者:萤火架构

链接:https://juejin.cn/post/7125652709952192548

来源:稀土掘金

著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。现在服务端向前端暴露的API一般都称自己为Restful API,肉眼可见的最明显特征就是application/json。但是json这个东西只能说是一个数据格式,它的好处就是表达数据清晰简单,但是要把restful和json画个等号就大错特错了。

也许你听说过Rest是面向资源的,但没有这样认真实践过,不知道怎样做才是最符合标准的。其实Rest有一个成熟度模型,最高的等级是超媒体控制,这有个专业的名词:HATEOAS(The Hypermedia As The Engine Of Application Statue)。如果你使用Java,可能看到过Spring HATEOAS,它就是用来实现这个最高等级的,不过用的人应该不多,这是为什么呢?下面会谈到这个问题。

我们先看一下成熟度模型的其它几个等级:

第0级:仅使用http作为通道。

我看见的很多API都停留在这个阶段,接口的形式还是RPC的形式,典型的特征就是get、set、add、delete等命名的接口满天飞,在这些接口中看不到任何基于资源的影子。get和post方法也是混用的,哪个方便用哪个。

第1级:以资源为中心。

我认为做到这一点才算真正的是Restful API了。形式如下:

/products/
/products/?name=foo
/products/1
/orders/

接口编写者提供的是资源,接口调用者访问的也是资源,而不再是执行某个动作。

有时候怎么定义资源需要琢磨一下,比如用户登录和退出,用restful API怎么写?

以前可能会这样写:

user/login
user/logout

现在想一下用户登录和退出操作的是什么资源?是会话。

所以登录可以是:Post /Session ,退出就是:Delete /Session

什么时候用Post?什么时候用Delete?下面马上讲。

第2级:利用http动作的语义。

这个有点难理解,看一个例子:

GET /products/1

GET语义上有幂等的意思,这里的幂等怎么理解?这个操作的意思是获取一个编号为1的产品,它不会更改资源的状态,如果调用API的时候超时了或者出错了,它可以安全地重试多次。

如果是POST动作,则语义上不是幂等的。它会改变资源的状态,比如银行转账,简单重试可能导致多扣一次钱。所以对于非幂等的操作,重试之前需要先检查资源的最新状态,否则可能会造成一些业务问题。

常用的Http动作还有Put、Delete等等,注意它们语义上都是幂等的,也就说可以安全重试,应用这两个动作的时候千万需要注意,实现上不要破坏这种幂等性。

绝大部分情况下,能够做到这一步就够了,算是标准合格的Restful API了。

第3级,终极等级,也就是前边提到的超媒体控制。做到这一步,客户端无需提前知道API的Path定义,服务端会返回资源的当前状态,以及下一步可以执行的各种标准动作。具体的就是通过link来给出各种处理资源的Path。这个有点像书的目录,具体样子请看附图。

出处。

1689151542866.png

应用到这一级的API比较少见,我认为是有点过于复杂了,编写服务端和客户端都比较麻烦,技术上有点理想化,实际的应用场景也比较少,我想不出来,欢迎补充。

另外还想说的是,restful和json不是绑定的,json只是一种最为流行的编码格式,在restful架构风格下,还可以使用xml、protobuf或者其它一些格式,经常见到的就是很多API支持根据http header中的accept返回json或者xml。

最后我们一般在对外提供服务的时候使用restful的接口,对内基于效率和习惯,还是使用RPC框架居多。RPC就不是面向资源的了,可以认为它面向的是业务模型,调用的是各种业务动作。不过RPC也可以基于Http协议,只使用其中的Post动作,比如大名鼎鼎的grpc就使用Http,这里Http协议被作为了一种传输协议,RPC协议则是上层业务协议。


好了,这篇文章就到这里。

你是怎么看待这个问题的?欢迎留言。

(封面图来源:Richardson Maturity Model (martinfowler.com)


相关文章
|
25天前
|
JSON 缓存 JavaScript
深入浅出:使用Node.js构建RESTful API
在这个数字时代,API已成为软件开发的基石之一。本文旨在引导初学者通过Node.js和Express框架快速搭建一个功能完备的RESTful API。我们将从零开始,逐步深入,不仅涉及代码编写,还包括设计原则、最佳实践及调试技巧。无论你是初探后端开发,还是希望扩展你的技术栈,这篇文章都将是你的理想指南。
|
18天前
|
JSON JavaScript 前端开发
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发作为连接用户与数据的桥梁,扮演着至关重要的角色。本文将引导您步入Node.js的奇妙世界,通过实践操作,掌握如何使用这一强大的JavaScript运行时环境构建高效、可扩展的RESTful API。我们将一同探索Express框架的使用,学习如何设计API端点,处理数据请求,并实现身份验证机制,最终部署我们的成果到云服务器上。无论您是初学者还是有一定基础的开发者,这篇文章都将为您打开一扇通往后端开发深层知识的大门。
34 12
|
21天前
|
XML JSON 缓存
深入理解RESTful API设计原则与实践
在现代软件开发中,构建高效、可扩展的应用程序接口(API)是至关重要的。本文旨在探讨RESTful API的核心设计理念,包括其基于HTTP协议的特性,以及如何在实际应用中遵循这些原则来优化API设计。我们将通过具体示例和最佳实践,展示如何创建易于理解、维护且性能优良的RESTful服务,从而提升前后端分离架构下的开发效率和用户体验。
|
24天前
|
监控 安全 API
深入浅出:构建高效RESTful API的最佳实践
在数字化时代,API已成为连接不同软件和服务的桥梁。本文将带你深入了解如何设计和维护一个高效、可扩展且安全的RESTful API。我们将从基础概念出发,逐步深入到高级技巧,让你能够掌握创建优质API的关键要素。无论你是初学者还是有经验的开发者,这篇文章都将为你提供实用的指导和启示。让我们一起探索API设计的奥秘,打造出色的后端服务吧!
|
22天前
|
JSON 缓存 测试技术
构建高效RESTful API的后端实践指南####
本文将深入探讨如何设计并实现一个高效、可扩展且易于维护的RESTful API。不同于传统的摘要概述,本节将直接以行动指南的形式,列出构建RESTful API时必须遵循的核心原则与最佳实践,旨在为开发者提供一套直接可行的实施框架,快速提升API设计与开发能力。 ####
|
24天前
|
JavaScript NoSQL API
深入浅出Node.js:从零开始构建RESTful API
在数字化时代的浪潮中,后端开发如同一座灯塔,指引着数据的海洋。本文将带你航行在Node.js的海域,探索如何从一张白纸到完成一个功能完备的RESTful API。我们将一起学习如何搭建开发环境、设计API结构、处理数据请求与响应,以及实现数据库交互。准备好了吗?启航吧!
|
25天前
|
JSON API 数据格式
探索后端开发:从零构建简易RESTful API
在数字时代的浪潮中,后端开发如同搭建一座桥梁,连接着用户界面与数据世界。本文将引导读者步入后端开发的殿堂,通过构建一个简易的RESTful API,揭示其背后的逻辑与魅力。我们将从基础概念出发,逐步深入到实际操作,不仅分享代码示例,更探讨如何思考和解决问题,让每一位读者都能在后端开发的道路上迈出坚实的一步。
|
22天前
|
JSON API 开发者
深入理解RESTful API设计原则
在数字化时代,API已成为连接不同软件应用的桥梁。本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可扩展的网络服务接口。通过解析REST架构风格的核心概念,我们将了解如何设计易于理解和使用的API,同时保证其性能和安全性。
|
22天前
|
存储 缓存 API
深入理解RESTful API设计原则
在现代软件开发中,RESTful API已成为前后端分离架构下不可或缺的通信桥梁。本文旨在探讨RESTful API的核心设计原则,包括资源导向、无状态、统一接口、以及可缓存性等,并通过实例解析如何在实际应用中遵循这些原则来构建高效、可维护的API接口。我们将深入分析每个原则背后的设计理念,提供最佳实践指导,帮助开发者优化API设计,提升系统整体性能和用户体验。
19 0
|
22天前
|
安全 测试技术 API
构建高效RESTful API:后端开发的艺术与实践####
在现代软件开发的浩瀚星空中,RESTful API如同一座桥梁,连接着前端世界的绚丽多彩与后端逻辑的深邃复杂。本文旨在探讨如何精心打造一款既高效又易于维护的RESTful API,通过深入浅出的方式,剖析其设计原则、实现技巧及最佳实践,为后端开发者提供一份实用的指南。我们不深入晦涩的理论,只聚焦于那些能够即刻提升API品质与开发效率的关键点,让你的API在众多服务中脱颖而出。 ####
30 0