REST这个词,是Roy Thomas Fielding博士在他2000年提出的,有兴趣的可以阅读一下他的论文, 论文地址为:http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm。

目前主流的Web服务实现方案中,因为REST模式的Web服务与复杂的SOAP和XML-RPC相对比,更加简洁,越来越多的Web服务开始采用REST风格设计和实现。例如Amazon.com提供接近REST风格的Web服务进行图书查找;雅虎提供的Web服务也是REST风格的,简单来说就是复用HTTP协议定义好的一组动词。

RESTful的优点:

  • 不需要解释即明白某个接口设计的意图

  • 接口和资源一一对应,方便写代码

  • 方便做权限控制

  • 为前端提供足够的灵活性

  • 在API升级过程中URL的改动较少,减少版本管理的工作量

基本信息

Representational State Transfer,表现层状态转移,如果一个架构符合REST原则,就称之为RESTful架构。

资源(Resource),网络上的一个实体,或者说是网络上的一个具体信息,URI就成了每一个资源的地址或独一无二的识别符。

表现层(Representation),"资源"是一种信息实体,它可以有多种外在表现形式,"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。

状态转化(State Transfer),和服务器互动,势必涉及到数据和状态的变化,互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端,客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。

几个需知点:

1. REST是一种架构风格的指导规范,而不是技术实现

2. 网站即软件,网站即服务

2.REST中信息的抽象即资源

3. 交互的对象——资源集合[名词]

4. http verbs—>URIs—>entities

5. URL中不存在动词,把动作省略,作为一种服务

6. 无状态

7. http 四个动词,GET获取,POST新建,PUT更新(全部),DELETE删除,PATCH更新(部分)

  • GET(SELECT):从服务器取出资源(一项或多项)。

  • POST(CREATE):在服务器新建一个资源。

  • PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。

  • PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。

  • DELETE(DELETE):从服务器删除资源。

  • HEAD:获取资源的元数据。

  • OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。

8. 数据格式JSON(推荐)

9. 安全性(修改数据的操作被认为是不安全的) 与 幂等性(GET, PUT,HEAD,DELETE),幂等性是指对同一资源的任意多次请求,语义相同

简单实践

根据id删除、修改、查询单个资源

eg:xxx/order/1 ( order即指那个单独的资源 )

  • GET - 返回id是1的order

  • DELETE - 删除id是1的order

  • PUT - 更新id是1的order,order的值从请求的内容体中获取

获取复数资源信息

eg: xxx/orders

  • GET - 返回所有orders

查询复数资源

eg:xxx/orders?name=123

  • GET - 返回所有满足查询条件的order资源

创建多个资源

eg:xxx/orders

  • POST - 将返回所有创建成功的orders的id数组

删除多个资源

eg:xxx/orders?id=[]

  • DELETE - 根据条件,批量删除多个资源

修改多个资源

eg:xxx/orders?id=[]&params=[]

  • PUT - 根据id数组,批量更新多个资源的属性

当然,目前而言rest风格的api才刚刚开始兴起,在实际的设计场景中,还需要根据场景决定是否使用。其实没有任何一种接口风格是所有开发者都推崇的,但还是建议多实践,根据实际业务场景选择即可。

RESTFul 设计规范的更多相关文章

  1. restful设计规范

    什么是restful? REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移” REST从资源的角度类 ...

  2. 秒杀系统-web

    秒杀系统Web层主要涉及前端交互设计.Restful:url满足Restful设计规范.Spring MVC.bootstrap+jquery这四个方面的开发.秒杀系统的前端交互流程设计如下图6-3所 ...

  3. PHP开发规范1.3.3

    PHP 开发规范1.3.3 一.编程规约 (一) 命名风格 [强制]代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式. 说明: 正确的英文拼写和语法可以让阅读者易于理解,避免歧义. ...

  4. Adnc简介

    Adnc是一个轻量级的.Net Core微服务(microservices)快速开发框架,同时也可以应用于单体架构系统的开发.框架基于JWT认证授权,包含基础的后台管理功能,代码简洁.易上手.学习成本 ...

  5. SpringCloud 微服务最佳开发实践

    Maven规范 所有项目必须要有一个统一的parent模块 所有微服务工程都依赖这个parent,parent用于管理依赖版本,maven仓库,jar版本的统一升级维护 在parent下层可以有 co ...

  6. Restful API设计规范及实战

    Restful API的概念在此就不费口舌了,博友们网上查哈定义文章很多,直入正题吧: 首先抛出一个问题:判断id为 用户下,名称为 使命召唤14(COD14) 的产品是否存在(话说我还是很喜欢玩类似 ...

  7. rest-framework 序列化格式Restful API设计规范

    理解RESTful架构 Restful API设计指南 理解RESTful架构 越来越多的人开始意识到,网站即软件,而且是一种新型的软件. 这种"互联网软件"采用客户端/服务器模式 ...

  8. Restful API设计规范及实战【说的比较清楚了】

    Restful API设计规范及实战   Restful API的概念在此就不费口舌了,博友们网上查哈定义文章很多,直入正题吧: 首先抛出一个问题:判断id为 用户下,名称为 使命召唤14(COD14 ...

  9. RESTful api 设计规范

    该仓库整理了目前比较流行的 RESTful api 设计规范,为了方便讨论规范带来的问题及争议,现把该文档托管于 Github,欢迎大家补充!! Table of Contents RESTful A ...

随机推荐

  1. 震惊!程序员的福音!不需要敲代码就能完成复杂的逻辑应用? —— Azure Logic App

    (大家看完标题可能以为是营销号,哈哈哈哈哈哈哈哈哈...客官请留步, 正经博主....好吧) 今天我们的主题是Azure Logic Apps Azure Logic Apps 是什么? 官方解释:h ...

  2. 【LeetCode】15.三数之和

    题目描述 1. 三数之和 给你一个包含 n 个整数的数组 nums,判断 nums 中是否存在三个元素 a,b,c ,使得 a + b + c = 0 ?请你找出所有满足条件且不重复的三元组. 注意: ...

  3. H - 蓬松的头发 HDU - 5504

    给你一个N个整数的序列. 你应该选择一些数字(至少一个),并使它们的乘积尽可能大. 它保证你在初始序列中选择的任何数的乘积的绝对值不会大于263−1. Input 在第一行有一个数字T(表示样例数). ...

  4. 在操作Git Bash时出现的问题

    参考博客:https://blog.csdn.net/weixin_44394753/article/details/91410463 1.问题1 $ git remote add origin gi ...

  5. Chrome截图截满滑动栏,QQ截长屏,录屏

    1.Chrome截图截满滑动栏 一般我们截图都是用QQ的Ctrl+shift+A,但是网页不好截,这里我们可以用Chrome控制台来截全网页: F12或Ctrl+shift+i打开控制台: 点击一下控 ...

  6. X-Admin&ABP框架开发-版本管理

    多租户系统中,针对于不同租户开放不同功能,或是按照不同功能进行收费管理,需要从宿主本身去管理租户的版本信息,如同酒店人员对不同房间收取不同费用,依据房间内部设施,房间大小等设置不同收费标准.Abp系统 ...

  7. Nginx知多少系列之(一)前言

    目录 1.前言 2.安装 3.配置文件详解 4.工作原理 5.Linux下托管.NET Core项目 6.Linux下.NET Core项目负载均衡 7.Linux下.NET Core项目Nginx+ ...

  8. layui经典模块化前端UI框架初识

    layui产生背景 layui相对于vue来说确实稍有逊色,但是官网提供的入门文档以及完善的框架结构,使的很多人开始用layui来开发前端页面,那么什么人会去使用layui呢? 针对后端开发人员,在对 ...

  9. Git常用命令(一)

    $ git init 初始化仓库(会生成一个隐藏文件.git) $ git add + (文件名) 实现对指定文件的跟踪 $ git commit 提交更新$ git clone + URL 克隆远程 ...

  10. Java字符串的应用

    字符串的简单应用 public class join { public static void main (String args[]){ String s1 = new String (" ...