RESTful设计风格

最新推荐文章于 2025-04-02 21:27:54 发布
最新推荐文章于 2025-04-02 21:27:54 发布
阅读量1k 收藏 4
点赞数 1
分类专栏： 设计 文章标签： RESTful REST 设计风格
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_36377960/article/details/89322337
版权

一 概述

一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。

REST(Representational State Transfer)，翻译过来叫“表述性状态转移”，它首次出现在 2000 年 Roy Fielding 的博士论文中，Roy Fielding是 HTTP 规范的主要编写者之一。

REST指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是RESTful。

总的来说，这更像是一种思想、理念，REST本身并没有增添新的技术，利用Web现有的特征和能力，更好地使用现有Web标准中的一些准则和约束。

 

二 数据字典

     1.HTTP请求方法

根据HTTP标准，HTTP请求可以使用多种请求方法。

HTTP1.0定义了三种请求方法：GET,POST和HEAD方法。

HTTP1.1新增了五种请求方法：OPTIONS,PUT,DELETE,TRACE和CONNECT。

序号方法描述
1GET请求指定的页面信息，并返回实体主体。
2HEAD类似于get请求，只不过返回的响应中没有具体的内容，用于获取报头
3POST向指定资源提交数据进行处理请求（例如提交表单或者上传文件）。数据被包含在请求体中。POST请求可能会导致新的资源的建立和/或已有资源的修改。
4PUT从客户端向服务器传送的数据取代指定的文档的内容。
5DELETE请求服务器删除指定的页面。
6CONNECTHTTP/1.1协议中预留给能够将连接改为管道方式的代理服务器。
7OPTIONS允许客户端查看服务器的性能。
8TRACE回显服务器收到的请求，主要用于测试或诊断。

在SpringMVC中有对应的注解标明映射极其方法：@GetMapping、@PostMapping、@DeleteMapping、@PutMapping

     2. 资源

REST 表述性状态转移，这里是指资源的表述。资源可以是实体，也可以只是一个抽象概念。

教务系统中教师（teachers）、学生（students）、教务（admins）、教务对象教师的管理（adminTeacher），

博客系统中文章（articles）、评论（comments），这些都是代表的资源。下面列举网上找到的 一些例子：

  • 某用户的手机号码
  • 某用户的个人信息
  • 最多用户订购的GPRS套餐
  • 两个产品之间的依赖关系
  • 某用户可以办理的优惠套餐
  • 某手机号码的潜在价值

 

     3. 动作

对资源所要进行的操作，常见的有更新（update）、删除（delete）、查询（select/get）、添加（get/add）

 

三 案例分析

假设现在有一个项目example(某教务系统)，其中有一个模块是教务模块，其中教师管理页面删除教师请求的服务端API地址：

http://example/adminTeacher/delete

以往我们设计后端请求url映射路径时，会将动作指示（即我们要进行的操作）写入，但是RESTful是面向资源的架构，所有其URL应该是一个资源，而且不包含任何动作，而动作的体现即对资源的具体操作类型应该由HTTP请求方法表示，动作不应该存在于URL中，delete是一个动作，因此不符合该特点，所有删除教师对应的RESTful API应该是：

http://example/adminTeacher/6

对应的http请求是DELETE。
 

 

四 设计原则

URI：

  • URL中尽量不用大写；
  • URI中不应该出现动词，动词应该使用HTTP方法表示但是如果如果无法表示，也可以使用动词，例如：search没有对应的HTTP方法，可以在路径中使用search，更加直观。
  • URI中的名词表示资源集合，使用复数形式；
  • URI可以包含queryString（过滤参数），避免层级过深。

服务端数据返回：

  • 最后是返回的JSON格式数据，即在SpringMVC中控制层可以利用@RestController或者@ResponseBody

版本控制：

  • 规范的API接口应该包含版本信息，在RESTful API中，简单的就是将版本信息放在url中，如：
[GET]    http://example.com/v1/articles?page=1&rows=10 
[PUT]    http://example.com/v1/articles/12
  • 或者是使用HTTP header中的accept来传递版本信息

参考博客：http://www.cnblogs.com/han-1034683568/p/7196345.html
 

五 设计技巧

设计技巧大家可以参考GitHub网站：

  • https://github.com/git
  • https://github.com/git/git
  • https://github.com/git/git/blob/master/block-sha1/sha1.h
  • https://github.com/git/git/commit/e3af72cdafab5993d18fae056f87e1d675913d08
  • https://github.com/git/git/pulls
  • https://github.com/git/git/pulls?state=closed
  • https://github.com/git/git/compare/master…next

下面让我们来看看URI设计上的一些技巧:

  • 使用_或-来让URI可读性更好

曾经Web上的URI都是冰冷的数字或者无意义的字符串，但现在越来越多的网站使用_或-来分隔一些单词，让URI看上去更为人性化。 例如国内比较出名的开源中国社区，它上面的新闻地址就采用这种风格， 如http://www.oschina.net/news/38119/oschina-translate-reward-plan。

  • 使用/来表示资源的层级关系

例如上述/git/git/commit/e3af72cdafab5993d18fae056f87e1d675913d08就表示了一个多级的资源， 指的是git用户的git项目的某次提交记录，又例如/orders/2012/10可以用来表示2012年10月的订单记录。

  • 使用?用来过滤资源

很多人只是把?简单的当做是参数的传递，很容易造成URI过于复杂、难以理解。可以把?用于对资源的过滤， 例如/git/git/pulls用来表示git项目的所有推入请求，而/pulls?state=closed用来表示git项目中已经关闭的推入请求， 这种URL通常对应的是一些特定条件的查询结果或算法运算结果。

  • ,或;可以用来表示同级资源的关系

有时候我们需要表示同级资源的关系时，可以使用,或;来进行分割。例如哪天github可以比较某个文件在随意两次提交记录之间的差异，或许可以使用/git/git /block-sha1/sha1.h/compare/e3af72cdafab5993d18fae056f87e1d675913d08;bd63e61bdf38e872d5215c07b264dcc16e4febca作为URI。 不过，现在github是使用…来做这个事情的，例如/git/git/compare/master…next。

参考博客：https://www.runoob.com/w3cnote/restful-architecture.html

 

养成良好的编码习惯，受益终生！！！

Restful API的设计与实践
虫草
12-08 1729
Restful这个名称应该很多人都不陌生，但是我发现不少人对Restful存在或多或少的理解偏差，其中不泛比较厉害的程序员，所以有必要为Restful来“正名”。Restful是一种软件架构风格，设计风格而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。（详见百度百科介绍）Restful的关键是抽取资
Restful 应用分析
weixin_33721344的博客
08-27 319
Restful API 近年来应用越来越广泛，各大互联网公司纷纷推出了自己的 Restful API 服务。 本文将从实际应用出发，从 REST 到 Restful 再到 Restful API ，逐一进行介绍和分析。 REST 风格 REST 风格最早由 Roy Thomas Fielding 博士提出， REST 是一种系统架构设计...
RESTful 设计风格
最新发布
m0_46515715的博客
04-02 954
RESTful 是一种基于REST架构风格的软件设计模式，旨在通过简洁、统一、标准化的方式实现分布式系统间的交互。其核心思想是将资源抽象为可操作的实体，并通过 HTTP 协议的标准方法（如 GET、POST、PUT、DELETE）来实现客户端与服务器之间的通信。
RESTful设计
D先生的博客
10-12 976
关于REST的URI设计 1、URI中不应该包含动词 因为"资源"表示一种实体，所以应该是名词，URI不应该有动词， 动词应该放在HTTP协议中。 举例来说，某个URI是/posts/show/1，其中show是动词，这个URI就设计错了，正确的写法应该是/posts/1，然后用GET方法表示show。 如果某些动作是HTTP动词表示不了的，你就应该把动作做成一种资源。比如网上汇款，从账户1向账户...
restful设计风格
08-19
RESTful 设计风格是一种用于构建 Web 服务的架构风格。它基于 HTTP 协议，并遵循一些设计原则，如统一接口、无状态性、可缓存性等。RESTful 架构的核心思想是将资源及其状态以 URL 的形式暴露，并使用 HTTP 方法（如...
restful设计风格.docx
06-12
### RESTful设计风格详解 #### 一、RESTful架构概述 RESTful（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于约束条件和预设，利用HTTP协议特性，可以实现简洁、高效的Web服务。...
Restful风格设计
shugyin的专栏
10-18 529
Restful风格设计、优劣势对比
Nkuvr-Admin:基于 SpringBoot + Mybatis + Thymeleaf 的实验室管理平台。平台实现了用户管理、实验室预约的管理等功能。前端使用 Thymeleaf 开发，通过 ajax 与后端交互。后端遵循 RESTful 设计风格
05-14
后端遵循 RESTful 设计风格。 实验室预约管理系统 需求分析 该系统的用户分为两种：管理员、学生 以下针对两种用户分别描述其功能需求 1、管理员功能需求描述 登录 密码重置 用户管理 预约管理 实验室管理 退出登录 ...
RestFul设计风格
mry
10-11 235
RestFul风格 RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。 (主要是避免代码的冗余，将动词和名词拆分) HTTP动词 Get(select): 查 Post(create) : 增 Put(update) : 改 Delete(delete) : 删 名词举例 名词要用复数形式 Get /users Pos
什么是RESTful的设计风格？
nmj2008的博客
02-23 203
RESTful其实只是一种风格。它的精髓在于，将你的HTTP的地址和你的资源进行一一对应。也就是，根据你的http地址就能返回给你想要的数值。那么，自然会对你的URL有一定的规范，每一个URL对应一个API。在这个API中会接收你的请求，并进行解析，找到你要找的数据，返回给你数据，一般是用json格式返回。 RESTful API接口设计标准及规范：https://blog.youkuaiyun.com/qq_41606973/article/details/86352787 ...
RESTFul风格接口如何设计
m0_63949203的博客
10-02 361
RESTFul风格接口如何设计
RESTful 设计风格有了解吗？
灰寨小学的python---小陈
07-19 2219
（视图主要用于封装结果，生成页面展示的html内容） RESTful 是一种开发理念，简洁，；层次感，主要体现在每个URL代表一种资源，所以在开发REST API 接口时，视图中要频繁的进行序列化和反序列化，将数据库数据序列化为前端所需要的格式，并返回，将前端发送的数据反序列化为模型类对象，并保存到数据库中· 之前的开发的一个电商商城就是用这种 RESTful 设计风格，我们将 API部署在专...
RestFul风格设计和实战
m0_50460160的博客
12-02 606
通过遵循RESTful架构的设计原则，可以构建出易于理解、可扩展、松耦合和可重用的Web服务RESTful API的特点是简单、清晰，并且易于使用和理解，它们使用标准的HTTP方法和状态码进行通信，不需要额外的协议和中间件。客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作:GET用来获取资源，POST用来新建资源(也可以用于更新资源),PUT用来更新资源，DELETE用来删除资源；资源的标识符应该能明确地说明该资源的信息，同时也应该是可被理解和解释的。
RESTful 风格详解
weixin_43189971的博客
07-29 9358
@RequsetParam @PathVariable 使用规范
Restful设计风格
ammmao的博客
07-16 303
文章目录RESTFUL1.协议2.HTTP方法3.使用名词4.集合功能5.状态码6.错误处理7.版本8.返回结果 RESTFUL RESTful(Representational State Transfer),表现层状态转义。 通俗来讲就是：资源在网络中以某种表现形式进行状态转移。分解开来 它首次出现在2000年ROY Fielding的博士论文中，Roy Fielding是HTTP规范的编写者...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值