说说自己对RESTful API的理解s

REST不是英文上的rest单词,其英文缩写为presentational State Transfer ,直译为表现状态转移,咋看起来很学术,不懂,其实不用去死抠这个词的意思。REST是一种约束和架构(设计),符合这个风格的都算API。如果实在想了解REST ,直接看提出REST的那篇论文。

知乎上有句话总结的很好了,URL定位资源用HTTP动词(GET POST DELETE)描述操作。

其实只要理解以下几个原则就可以了:

1.提供资源定位

一般在计算机系统中,client和server通信交换信息,发出Action来完成任务。假设在一个to-do-list的Web应用中,客户需要添加或者修改to-do-list,如果用非

REST的方法是这样的:

www/changeTodoList.php?item=35&action=changeTitle&title=new_title

以上的URL是向Web API发出修改的指令,之后跟着的是一些修改的参数。但是,changeTodoList.php表述的不是一个事物,也不是一个资源(resource),在REST的架构风格中,服务器只提供资源(only offer resources), 资源表述的是C/S通信中的概念(即名词)。以下就是REST的方式:

www/todolists/7/items/35/

以上的URL在语义上表现就不是一些系列命令了,只仅仅是资源的URL地址。

2.只交换自描述(self-descriptive)的消息

考虑以下场景:

/search-results?q=todo

/search-results?page=2

/search-results?page=3

以上的Web API,第一个代表搜索todo的结果,第二行todo结果的第二页,之后类推。但是单独从第二行的参数就无法看出这API是干嘛的,什么的第二页?不得而知。

以下是RESTful的设计:

/search-results?q=to-do

/search-results?q=todo&page=2

/search-results?q=todo&page=3

这样单独每行都能解释自身的意思,也就是自圆其说了。

3.通过连接(Links)链接资源(resources)

假设App向server端请求你的to-do-list:

/todolists/7/
{"name": "My to-dos",

"items": [35, 36]

}

返回了以上的json串,item号数为35,36,但是App开发者应该从哪里通过item号来获取API呢?没办法,得通过提供的文档来向相关的Item查找Web API来查。

以下是RESTful的设计:
todolists/7/

{

"name": "My to-dos",

"items": ["/todolists/7/items/35/", "/todolists/7/items/36/"]

}

上面json直接返回相关item的URL,App开发者直接就可以获取字符串发送请求了。

只要遵循以上几个原则,那么设计出来的API就是RESTful的。

references:
https://www.zhihu.com/question/28557115

时间: 2024-10-25 19:50:54

说说自己对RESTful API的理解s的相关文章

网上整理的对于Rest和Restful api的理解

一.什么是Rest? REST不是"rest"这个单词,而是几个单词缩写 -- REpresentational State Transfer 直接翻译:表现层状态转移,但这个翻译正常人根本看不懂,找到的一种最好理解的说法是,URL定位资源,用HTTP动词(GET,POST,DELETE,DETC)描述操作. 二.Restful api接口有什么特征? REST描述的是在网络中client和server的一种交互形式:REST本身不实用,实用的是如何设计 RESTful API(RES

理解restful API

简介 随着Web开发的不断开发, 低耦合的需求被提上了日程, 催生出了前后端分离的方案. 前后端分离使前端和服务器端相互独立, 细化前后端开发, 于是近几年API架构风行. RESTful架构由Roy Fielding在一篇博士论文中提出. `REST, 即Representational State Transfer的缩写, 中文可以译为表现层状态转化 表现层可以理解为资源的表现层, 资源在网络通信中无处不在, 一段文本, 一张图片, 一个文档都是资源, JSON是现在最常用的资源表示格式.

理解restful 架构 && RESTful API设计指南

restful是前端和后端接口中都会使用的设计思想. 网站即软件,我们也常说的webapp,这种互联网软件采用的是“客户端/服务器”模式,建立在分布式体系上. 网站开发,也可以完全采用软件开发的模式,但是传统上软件和网络还是不同的领域,因为: 软件开发主要针对单机环境,而网络是研究系统之间的通信. 互联网的兴起,使得这两个领域开始融合,现在我们开始考虑,如何开发在互联网环境中使用的软件. RESTful架构,就是目前最为流行的一种互联网软件架构,它结构清晰.符合标准.易于理解.扩展方便,所以正得

flask开发restful api

在此之前,向大家说明的是,我们整个框架用的是flask + sqlalchemy + redis.如果没有开发过web,还是先去学习一下,这边只是介绍如果从开发web转换到开发移动端.如果flask还不是很熟悉,我建议先到这个网站简单学习一下,非常非常简单.http://dormousehole.readthedocs.org/en/latest/ 一直想写一些特别的东西,能让大家学习讨论的东西.但目前网上的很多博客,老么就按照官方文档照本宣读,要么直接搬代码,什么都不说明.我写这个系列的博客,

[CI] 使用CodeIgniter框架搭建RESTful API服务

在2011年8月的时候,我写了一篇博客<使用CodeIgniter框架搭建RESTful API服务>,介绍了RESTful的设计概念,以及使用CodeIgniter框架实现RESTful API的方法.转眼两年过去了,REST在这两年里有了很大的改进.我对于前一篇博客中的某些方面不是很满意,所以希望能利用这次机会写一个更加完善的版本.我的项目基于Phil Sturgeon的CodeIgniter REST Server,遵循他自己的DBAD协议.Phil的这个项目很棒,干净利落,简单实用,并

拿nodejs快速搭建简单Oauth认证和restful API server攻略

拿nodejs快速搭建简单Oauth认证和restful API server攻略:http://blog.csdn.net/zhaoweitco/article/details/21708955 最近一直在鼓捣这个东西,拿出来分享下一下经验吧,其实很简单,一点也不难. 首先需求是这样,给自己的网站要增加API服务,API分为两种,公共的和私有授权的,授权的使用Oauth方法认证身份,API格式均为JOSN和JSONP. 嗯,别的语言我也没怎么学过,首先是找合适的框架进行实现吧.本身网站使用的e

restful api (转)

RESTful API 概述 参考地址 RESTful架构是一种流行的互联网软件架构,它结构清晰,符合标准,易于理解,扩展方便.REST是Representational State Transfer的缩写,翻译为“表现层状态转化”.表现层其实就是资源,因此可以理解为“资源状态转化”.网络应用上的任何实体都可以看作是一种资源,通过一个URI(统一资源定位符)指向它. 表现层(Representation) “资源”是一种信息实体,它可以有多种外在表现形式.我们把“资源”具体呈现出来的形式叫做它的

RESTful API 设计指南(转)

网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备......). 因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信.这导致API构架的流行,甚至出现"API First"的设计思想.RESTful API是目前比较成熟的一套互联网应用程序的API设计理论.我以前写过一篇<理解RESTful架构>,探讨如何理解这个概念. 今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理.好用的API

RESTful API 设计指南

RESTful API 设计指南 本人来源于:http://www.ruanyifeng.com/blog/2014/05/restful_api.html 作者: 阮一峰 日期: 2014年5月22日 网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备......). 因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信.这导致API构架的流行,甚至出现"API First"的设计思想.RESTful API是目前比