RESTful学习及应用

原文转自前端路上,转载请注明出处:http://refined-x.com/2017/09/22/RESTful学习及应用/

RESTful是什么

RESTful是一种API架构,符合REST设计原则的API都可以被称为RESTful,REST的全称是Representational State Transfer

REST的核心原则是后端将资源发布为URI,前端通过URI访问资源,并通过HTTP动词表示要对资源进行的操作,典型的RESTful API长这样:

POST /artical           //增加一篇文章
DELETE /artical/1       //删除id为1的文章
PUT /artical/1          //修改id为1的文章
GET /articals/1         //查询id为1的文章

这里需要明确一个概念:资源,后端提供的所有内容都可以被定义为资源,前端用户的一切行为,本质都是与一系列后端资源互动的结果。从这个角度来讲,前端的意义就是连接用户与资源,使用户能以最简单的方式调度后端资源,并将调度结果以用户最容易接受的方式呈现出来。

为什么使用RESTful

前后端分离的本质是前后端以API为界限进行开发解耦,所以前后端分离的副产品是大量的API,采用RESTful架构可以让API的表现力更强,更易于被理解;对于接口开发来说,RESTful风格也更易于扩展,这对于大型项目非常重要。

RESTful是无状态的,因此无论前端是什么设备,前端是什么状态,都可以无差别的请求资源,有利于后端实现分布式。

RESTful允许前端索取指定格式的信息,因此可以实现一套统一的API服务于不同的前端设备。

如何构建RESTful API

一、每个网址代表一种资源,网址中只能有名词

网址仅用来表示资源的名称,而不包括操作,因此只能由名词组成;但有些资源可能自带操作属性,比如转账,这时候我们应该将转账看成一种服务(名词),将转账的其他信息作为参数传递

二、对于资源的操作类型由HTTP动词表示

常用的四种HTTP动词以及对应的SQL操作。

GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)
DELETE(DELETE):从服务器删除资源。

三、统一的返回结果

针对不同操作,服务器向用户返回的结果应该符合以下规范。

GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档

四、返回正确的状态码

常用状态码

200 :服务器成功返回用户请求的数据
400 :用户发出的请求有错误
401 :表示用户没有权限
403 : 表示用户得到授权(与401错误相对),但访问被禁止的
404 :用户发出的请求针对的是不存在的记录
500 :服务器发生错误,用户无法判断发出的请求是否成功

五、允许通过HTTP内容协商

客户端可以通过Accept头请求一种特定格式的表述,服务端则通过Content-Type告诉客户端资源的表述形式。若服务器不支持,它应该返回一个HTTP 406响应,表示拒绝处理该请求。

通常项目中最常用的还是直接预定为JSON格式。

web端的应用

目前最流行的web端AJAX类库当属axios,axios与RESTful完美兼容,主要体现在以下几个方面。

axios将HTTP动词直接封装为方法,正好对应RESTful的API风格,在RESTful架构中使用起来非常方便

axios.post(`/artical`, params)
axios.delete(`/artical/1`, params)
axios.put(`/artical/1`, params)
axios.get(`/artical/1`, params)

而且axios的返回数据包括响应正文和状态码等信息,配合拦截器很容易实现对RESTful API错误码的统一处理。

//错误处理
axios.interceptors.response.use(function(response) {
  return response;
}, function(error) {
  if (error.response) {
    switch (error.response.status) {
      case 400:

        break;
      case 401:

        break;
      case 403:

        break;
      ...
    }
  }
});

更多axios内容参考这里

最后

其实RESTful的绝大多数内容都是规范推荐的做法,没有什么新东西,只不过前几年后端MVC盛行的时期,没有这么重的API开发需求,在这方面就一切从简了,近来赶上前后端分离的东风,API设计又被大家重视起来了,重回规范的RESTful相当于让大家见识了一下当年规范制定者们的远见卓识,就像小时候不听话的孩子在长大的某一天里突然想起来长辈曾经的教诲一样。

时间: 2024-11-09 15:38:45

RESTful学习及应用的相关文章

RESTful学习笔记

作为一名只有几个月IT自学经历的人,在接受新知识的时候总是想找到浅显易懂的方式去理解,但往往却很难找到相关的文章,大部分都是针对具有一定经验的开发人员,因此在看了很多相关的文章才对RESTful架构有所了解,接下来我将以简单的方式描述RESTful,方便一些初学者容易理解,也作为自己的一个总结学习过程. RESTful简介 在谈 RESTful 之前让我们先了解下什么是 Web Service,之所以要提这个是因为 RESTful 本身就是属于 Web Service 范畴,web servic

angular学习笔记(二十八)-$http(6)-使用ngResource模块构建RESTful架构

ngResource模块是angular专门为RESTful架构而设计的一个模块,它提供了'$resource'模块,$resource模块是基于$http的一个封装.下面来看看它的详细用法 1.引入angular-resource.min.js文件 2.在模块中依赖ngResourece,在服务中注入$resource var HttpREST = angular.module('HttpREST',['ngResource']); HttpREST.factory('cardResource

angular学习笔记(二十七)-$http(5)-使用$http构建RESTful架构

在angular中有一个特别为RESTful架构而定制的服务,是在$http的基础上进行了封装. 但是为了学习,我们先看看用直接$http是如何构建RESTful架构的: 假设有一个银行卡的列表.需要的功能有: 可以通过id来获取用户123的指定id的卡     'GET'  'card/user/123/id' 可以获取用户123的所有的银行卡             'GET'  'card/user/123' 可以更新用户123的指定id的卡                'POST' '

PHP再学习5——RESTFul框架 远程控制LED

0.前言 去年(2013年)2月第一次接触yeelink平台,当时该平台已经运行了一些时间也吸引了不少极客.试想自己也将投身IoT(物联网)行业,就花了些时间研究了它.陆陆续续使用和研究了一年,大致围绕两个问题展开——1.yeelink平台如何使用,2.如何构造一个功能简单些的yeelink平台.    [PHP学习笔记——索引博文] 本文将讨论如何构造一个简单restful架构平台(该平台有点像yeelink,不过功能比yeelink少的多),并结合树莓派实现LED的远程控制(网络控制).构建

物联网学习笔记——构建RESTFul平台1

0.前言 前些时间顺着Yeelink学习了RESTFUL,使用PHP和Slim框架尝试实现简单的REST API,树莓派可通过GET方法获得JSON数据包,通过这种方式实现了树莓派和服务器(我的PC)的互动.但是由于没有WEB前端,所以只能使用cURL工具或直接修改数据库的方式改变LED状态,体验非常差. REST API入门体验可参考 [PHP再学习4—— slim框架学习和使用] [PHP再学习5——RESTFul框架 远程控制LED] 受到[开源IOT——一个最小的物联网系统设计方案及源码

树莓派学习笔记——Restful服务 采用slim php apache

0.前言 前些时间沉迷于Restful,采用PHP+Slim+MySQL实现了一些简单的API函数.但是这些工作都是在windows中实现(采用wamp server集成安装包),但是转到linux中还确实有些不一样,下面就使用树莓派尝试一把. 1.安装php和apache2 在这里仅安装php和apache2,如果需要安装mysql请再增加php5-mysql和mysql-server sudo apt-get update sudo apt-get install apache2 php 2

springmvc学习笔记(19)-RESTful支持

springmvc学习笔记(19)-RESTful支持 springmvc学习笔记19-RESTful支持 概念 REST的样例 controller REST方法的前端控制器配置 对静态资源的解析 本文介绍RESTful的概念,并通过一个小样例展示怎样编写RESTful风格的controller和配置前端控制器,最后展示静态资源的解析 概念 首先附上两篇博客链接 理解RESTful架构 - 阮一峰的网络日志 RESTful API 设计指南- 阮一峰的网络日志 RESTful架构.就是眼下最流

Java实现Restful框架Jersey学习

Java与REST的邂逅(一):浅谈Jersey及JAX-RS Java与REST的邂逅(二):JAX-RS核心Annotation Java与REST的邂逅(三):浅谈Jersey MVC Java实现Restful框架Jersey学习

学习RESTful API

总是见到文章有提到RESTful API的,却不知道是什么东西,找到这篇文章,觉得讲得不错,就转载到这里来吧. 另外也有一篇文章也不错,发个链接:白话REST-识别真假REST ---------------------- 前几日,有一小哥突然问我:陈陈,你会RESTful API吗?我说:不会呀,他说:那我教你好了.然后我就把该小哥拉入"黑名单"了,理由是唱你妹的小星星.然后去深入的学习了一下REST相关的东西. RESTful API对我并不是一个全新的像是突然蹦出来的词汇,我印象