资讯频道 → 企业架构
阅读更多

4顶
0踩

企业架构

转载新闻 Restful API的设计与实践

2015-12-08 19:01 by 副主编 mengyidan1988 评论(0) 有6460人浏览
API 开放平台
本文转自简书
Restful这个名称应该很多人都不陌生，但是我发现不少人对Restful存在或多或少的理解偏差，其中不泛比较厉害的程序员，所以有必要为Restful来“正名”。

Restful是一种软件架构风格，设计风格而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。（详见百度百科介绍）

Restful的关键是抽取资源，使用URL与资源进行对应。这边也是多数人理解有偏差之处，即Restful应该理解为面向资源的架构风格，URL的设计应该是从资源的角度出发，而不应有任何的“动作”设计，其中单个资源共享同一个接口，而不同的“动作”通过请求的方法进行区分。这也是和RPC调用方式或RPC-Restful混合调用方式最大的不同之处。

那么为什么要使用Restful风格？有什么优势？

1、统一接口：约定大于配置，有了统一的规范，大家在接口设计时能够保证理解的一致性，这样首先便于接口的理解。另外同一资源URL一致，不同的CURD操作通过不同的Http协议方法进行区分，这样在设计上做到了简化。统一接口还有个非常容易被忽视的好处，就是方便使用Http协议自带的缓存机制对请求进行缓存操作，这样在一定程度上又提高了请求的性能。
2、无状态性：由于使用Http协议进行调用，每个请求都包含了服务器所需的全部信息，所以这种方式非常适用于异构系统之间的调用，同时也良好地支持分布式架构，可以动态地扩展服务器。这也是一个非常明显的优势。

Restful风格非常好，具体如何设计？

1、提取资源： 这一步非常关键，也是Restful的核心思想所在。在面向对象的世界里，对于资源的识别不算太难，一般情况下资源即是想要处理的对象，如果对应到表结构上面，可能就是表对应的实体。例如电子商务网站上的下订单，那资源就是订单；如果是商品展示，那资源就是商品。当然这是最简单的情况，如果稍微复杂一点，比如现在是家电类的商品展示怎么办呢？那资源就是商品-家电类。像上面所述的情况，资源比较好识别，而有些情况下资源就不是那么明显了，比如登录，这是哪门子资源？这种情况确实不太好抽象，不过可以理解为登录信息资源。登录操作是对登录信息资源的新增操作。还有其它更复杂的情况，这个就得发挥面向资源的思路做进一步的抽象了。
2、URI设计： URI的设计其实与资源提取紧密相关，基本只要资源提取出来了，URI只是相应地翻译成地址就可以，有层级的资源通过分隔符进行路径区分。例如上面提到的商品展示可以是/goods，家电类商品可以/goods/elecequipt/，而登录可以是/loginInfo。

3、具体的动作： 这个严格说来并不是设计的一部分，是属于规范的一部分。因为使用Http协议，而协议中正好有相应的方法支持，所以正好使用Http协议的方法。（1）GET：获取资源的方法；（2）PUT：更新资源的方法；（3）POST:创建资源的方法；（4）DELETE：删除资源的方法。这几个 是比较常用的，还有几个不太常用的方法：（5）OPTIONS：查看资源支持哪些方法；（6）HEAD：与PUT类似，只不过HEAD只返回报头，不返回表示。
这里需要着重提一下，很多Restful-RPC混合模式可能就只会使用POST方法，这里就是混合模式与Restful风格最明显的区别之一。

4、返回结果： 返回结果包括Http请求的状态码和资源的表述。很多情况下API的返回结果使用Json或者XML格式表示，而Json是更加常用的。因为Json相比XML更加轻量，这样在传输过程中资源更小传输更快，另外Json的解析支持更广，所以解析起来非常方便。

5、缓存： Http协议是天然支持缓存的，这个也有利于性能的提升。当然服务端也可以添加缓存提高性能，这是另一个话题。缓存具体的实现在Http Header里面进行设置，例如Cache-Control、Expires。具体用法可以参见协议头描述：http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

6、安全性： 如果资源是公开的，那也没有什么安全性可言了。但是实际情况是很多资源是有对应的“权限”进行操作的，这个时候就需要进行身份的认证，认证才能够进行相应的操作。所以安全性也是设计中很重要的一环。
那么安全性如何保证呢？在Http协议中有Authorization头可以进行相关设置，最基本的可以使用Basic方式，更加安全的加密方式使用Digest方式，更进一步提高安全性还可以使用第三方的OAuth协议进行认证，OAuth也是经常采用的方式。具体使用可参考网上看到的一篇非常好的博文：理解OAuth2.0。另外为了安全性的保证，大多数情况下还会选用https协议进行传输。

设计的思路有了，那么该如何付诸实践？

1、使用场景： 前面也提到了，Restful风格特别适合于异构系统之间的调用，另外在分布式场景中也比较适用。比如现在移动端APP的接口设计很多都采用这种风格，另外有不少云平台提供的服务接口也大多采用Restful风格设计。使用还是比较广泛的。
2、实践示例： 说了半天理论还是略显空洞，下面直接来点示例加深下理解。限于篇幅，这里推荐几个看到的比较好的例子。
简单情况下的使用示例可以参考网上看到的一篇非常好的博文：理解Restful架构。
稍微复杂一点的情况可以考虑现在比较知名的云平台的API设计，比如百度云推送API设计：http://push.baidu.com/doc/restapi/restapi。另外还推荐一个看到的Saas服务商的Restful设计文档，写得很好，环信的聊天API设计：http://docs.easemob.com/doku.php?id=start:100serverintegration。
这边有几个有意思的地方可以特别关注下，比如API中的安全认证设计、接口输入输出设计。另外如果看得仔细，可能会注意到百度云平台推送平台的API设计可能与前面提到的Restful本身的设计思路有些出入，百度云推送的设计方式严格说来应该算是Restful-Rpc混合模式的设计。不过也不影响做为参考。

3、框架支持： 这里以Java版本的为例。Java对于Restful有一个规范定义JAX-RS，而支持Restful框架也不少，比如：Restlet、Jersey、RESTEasy、CXF。这几个框架的比较可以参考这篇博文：http://www.infoq.com/cn/news/2008/10/jaxrs-comparison/。我对Restlet和Jersey进行了简单了解，没有做深入的使用，觉得Restlet的文档是做得更好的。
除了上面提到的框架，现在非常流行的Spring MVC框架也对Restful有良好的支持，比如可以参考这篇的实践：http://www.importnew.com/7903.html，Spring框架的支持还是非常不错的。
来自: 简书
4
顶
0
踩
评论 共 0 条 请登录后发表评论

发表评论

您还没有登录,请您登录后再发表评论

相关推荐

  • RESTfulAPI设计最佳实践

    目前互联网上充斥着大量的关于RESTfulAPI（为了方便，以后API和RESTfulAPI一个意思）如何设计的文章，然而却没有一个”万能“的设计标准：如何鉴权？API格式如何？你的API是否应该加入版本信息？目前互联网上充斥着...

  • RESTful API 设计最佳实践

    这些REST的关键原则与将你的 API 分割成逻辑资源紧密相关。使用HTTP请求控制这些资源，其中，这些方法（GET, POST, PUT, PATCH, DELETE）具有特殊含义。 一旦定义好了资源, 需要确定什么样的 actions 应用它们，...

  • RESTful API设计与实践

    RESTful API即遵循REST原则的API，采用HTTP方法（GET、POST、PUT、DELETE等）对资源进行操作，使得不同平台和语言的客户端可以轻松地与服务器进行交互。本文介绍了RESTful API的概念、优势、应用场景以及常见问题和...

  • RESTful API 设计最佳实践1

    Roy Felding 在他论文 network based software architectures 的 第五章 中首次介绍了这些原则。这些REST的关键

  • Restful API 设计实践

    第一次接触Restful API设计规范是在本科的软工课上，当时懵懵懂懂的跟着助教的指导了解了Restful API的一些内容。后来在实验室产品的开发中第一版后端的API设计被同学吐槽不够Restful。由于接下来一段时间要做后端的...

  • RESTful图书管理系统架构设计-restful api 设计最佳实践WORD范本.docx

    RESTful图书管理系统架构设计-restful api 设计最佳实践WORD范本.docx

  • RESTful API设计最佳实践（转译）

    RESTful API设计最佳实践（转译）每个资源，使用两个URL用名词替代动词表示URL使用HTTP方法来操作URL在表示集合URL上，使用POST来创建新的资源在表示特定袁术URL上，使用PUT来表示更新资源坚持使用复数名词使用“？...

  • Restful API规范及实践

    RESTful API 最佳实践 22条API设计的最佳实践 1.定义 1.1 RESOUCE（资源） 对象的单个实例。 例如，一只动物。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源...

  • RESTful API 设计指南，RESTful API 设计最佳实践

    RESTful API 设计指南，RESTful API 设计最佳实践 网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面...RESTful API是目前比较成熟的一套互联网应用程序的API设计...

  • RESTful API 设计最佳实践（7）

    RESTful API 设计最佳实践（7）本篇博客将侧重介绍在RESTful API设计中，消息头HEADER和消息体body相关的东西。URL只是RESTful API设计的主要一部分，要实现REST的统一接口，HTTP协议中的其他部分也不可或缺。关于...

  • Restful api 设计最佳实践

    ● CURD的操作 ○ GET /users # 获取user列表 ○ GET /users/12 # 查看某个具体的user ○ POST /users # 新建一个user ○ PUT /users/12 # 更新user 12 ○ DELETE /users/12 #删除user 12 ...

  • RESTful API设计与实现

    RESTful API是遵循REST原则的Web API。它使用简单、通用的方法（如HTTP方法）来操作资源（如Web页面、数据对象等）。无状态：服务器不保存客户端的状态信息，每个请求都包含处理该请求所需的所有信息。客户端-服务器...

  • RESTful API 设计实践

    RESTful是目前流行的API设计规范，遵守这套规范设计出的API可以较好的适用不同类型的客户端，例如：PC/Mobile/Pad… RESTful 表现层状态转换（英语：Representational State Transfer，缩写：REST）是Roy Thomas ...

  • 【开发规范】API设计风格 RESTful API

    二、API设计： 1.API请求设计： 2.API响应设计： 三、API请求详解： 1.HTTP动词： 2. URL（宾语）必须是名词： 3.过滤信息（Filtering）： 4.不符合 CRUD 情况的 RESTful API： 5.动词覆盖，应对服务器不...

  • RESTful API 设计与最佳实践

    在这个系列博客中，我们将深入了解RESTful API的设计原则、优势、弊端以及一些建议，帮助你更好地构建和使用RESTful API。RESTful API 是一种基于资源的设计风格，通过标准的HTTP方法（如GET、POST、PUT、DELETE）对...

  • 蚁群算法和BP神经网络的Java实现.zip

    该资源内项目源码是个人的课程设计，代码都测试ok，都是运行成功后才上传资源，答辩评审平均分达到96分，放心下载使用！ ## 项目备注 1、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 2、本项目适合计算机相关专业(如计科、人工智能、通信工程、自动化、电子信息等)的在校学生、老师或者企业员工下载学习，也适合小白学习进阶，当然也可作为毕设项目、课程设计、作业、项目初期立项演示等。 3、如果基础还行，也可在此代码基础上进行修改，以实现其他功能，也可用于毕设、课设、作业等。 下载后请首先打开README.md文件（如有），仅供学习参考, 切勿用于商业用途。 该资源内项目源码是个人的课程设计，代码都测试ok，都是运行成功后才上传资源，答辩评审平均分达到96分，放心下载使用！ ## 项目备注 1、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 2、本项目适合计算机相关专业(如计科、人工智能、通信工程、自动化、电子信息等)的在校学生、老师或者企业员工下载学习，也适合小白学习进阶，当然也可作为毕设项目、课程设计、作业、项目初期立项演示

  • 6-1儿童节快乐项目游戏开发

    项目整体思路: 做出几个场景, 总体是冒险类型的, 没有战斗场景, 所以不能算是RPG 使用语言: C++ 使用游戏引擎: Cocos2d-x 3.16

  • 基于Selenium的Java爬虫实战(内含谷歌浏览器Chrom和Chromedriver版本116.0.5818.0)

    资源包括: 1.Java爬虫实战代码 2.selenium学习笔记 3.代码演示视频 4.谷歌浏览器chrom116.0.5818.0 chrome-linux64.zip chrome-mac-arm64.zip chrome-mac-x64.zip chrome-win32.zip chrome-win64.zip 5.谷歌浏览器驱动器Chromedriver116.0.5818.0 chromedriver-linux64.zip chromedriver-mac-arm64.zip chromedriver-mac-x64.zip chromedriver-win32.zip chromedriver-win64.zip 特别说明:Chrome 为测试版(不会自动更新) 仅适用于自动测试。若要进行常规浏览，请使用可自动更新的标准版 Chrome。)

  • 毕业设计，基于用户行为的社交网络推荐算法研究与实现

    基于用户行为的社交网络推荐算法研究与实现是一个结合了数据挖掘、机器学习和社交网络分析的项目。这个项目可以用于推荐用户可能感兴趣的内容或用户，以提高社交网络的互动性和用户体验。以下是一个基于用户行为的社交网络推荐算法的研究与实现建议： ### 1. 需求分析 - **用户角色**：确定系统的主要用户角色，如普通用户、内容创作者、管理员等。 - **核心功能**： - 用户行为分析：收集和分析用户在社交网络上的行为数据，如点赞、评论、分享等。 - 推荐算法：基于用户行为数据，设计推荐算法，推荐用户可能感兴趣的内容或用户。 - 系统集成：将推荐算法集成到社交网络平台中，实现推荐功能。 - 性能评估：评估推荐算法的准确性和效率。 ### 2. 技术选型 - **数据收集与处理**：使用爬虫或API接口收集用户行为数据，使用Python的Pandas、NumPy等库进行数据处理。 - **推荐算法**：研究并实现多种推荐算法，如协同过滤、基于内容的推荐、基于图的推荐等。 - **机器学习库**：使用Python的Scikit-learn、TensorFlow、PyTorch等库进

Global site tag (gtag.js) - Google Analytics