RestfulAPI超简单入门

简单入门

REST -- REpresentational State Transfer,英语的直译就是“表现层状态转移”

是目前最流行的 API 设计规范,用于 Web 数据接口的设计。

由客户端发出数据操作指令,后台接受决定如何操作。

粗暴解释:用HTTP动词(GET,POST,PUT,PATCH,DELETE)描述操作,其后接URL定位资源。

  • GET:读取(Read)
  • POST:新建(Create)
  • PUT:更新(Update)
  • PATCH:更新(Update),通常是部分更新
  • DELETE:删除(Delete)

类似于:

GET:http://www.ccc.com/source/id 就是获取指定ID的某一类资源

POST:http://www.ccc.com/vips/23 表示为指定ID为23的会员新增好友。

注意!: HTTP动词均为大写!

动词的覆盖

有些客户端只能使用GetPOST这两种方法。服务器必须接受POST模拟其他三个方法(PUTPATCHDELETE)。

这时,客户端发出的 HTTP 请求,要加上X-HTTP-Method-Override属性,告诉服务器应该使用哪一个动词,覆盖POST方法。

POST /api/Person/4 HTTP/1.1
X-HTTP-Method-Override: PUT

上面代码中,X-HTTP-Method-Override指定本次请求的方法是PUT,而不是POST

设计原则

RESTful API设计原则是无状态的。

所谓无状态即所有的资源都可以URI定位,而且这个定位与其他资源无关,也不会因为其他资源的变化而变化。

有状态和无状态的区别,举个例子说明一下,例如要查询员工工资的步骤为

第一步:登录系统。

第二步:进入查询工资的页面。

第三步:搜索该员工。

第四步:点击姓名查看工资。

这样的操作流程就是有状态的,查询工资的每一个步骤都依赖于前一个步骤,只要前置操作不成功,后续操作就无法执行。

如果输入一个URL就可以得到指定员工的工资,则这种情况就是无状态的,因为获取工资不依赖于其他资源或状态,且这种情况下,员工工资是一个资源,由一个URL与之对应可以通过HTTP中的GET方法得到资源,这就是典型的RESTful风格。

服务器回应

客户端的每一次请求,服务器都必须给出回应。回应包括 HTTP 状态码和数据两部分。

状态码:

HTTP 状态码就是一个三位数,分成五个类别。

  • 1xx:相关信息
  • 2xx:操作成功
  • 3xx:重定向
  • 4xx:客户端错误
  • 5xx:服务器错误

返回信息:

API 返回的数据格式应该为Json格式,所以,服务器回应的HTTP头的Content-Type属性要设为application/json.

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
  "error": "Invalid payoad.",
  "detail": {
     "surname": "This field is required."
  }
}

参考链接

RESTful API 最佳实践 by 阮一峰

什么是RESTful API? by hjc1984117

原文地址:https://www.cnblogs.com/bihanghang/p/10010271.html

时间: 2024-10-11 15:17:27

RestfulAPI超简单入门的相关文章

程序员,一起玩转GitHub版本控制,超简单入门教程 干货2

本GitHub教程旨在能够帮助大家快速入门学习使用GitHub,进行版本控制.帮助大家摆脱命令行工具,简单快速的使用GitHub. 做全栈攻城狮-写代码也要读书,爱全栈,更爱生活. 更多原创教程请关注头条号.每日更新.也可以添加小编微信:fullstackCourse.一起交流,获取最新全栈教程信息.因为FQ原因,不能下载客户端的同仁,可以关注后回复“GitHub客户端”获取安装软件. 上篇教程:GitHub这么火,程序员你不学学吗? 超简单入门教程 干货 GitHub概念部分出现了一丝纰漏.为

Git超简单入门简明教程--写给一直不敢用Git的同学

从2014年2月12号开始工作到现在,已经快小半年了,还记得第一次接触集中式版本控制工具SVN时的惊喜,这对于之前一直独立开发的我来说,才明白原来代码还可以这样管理!当然,现在对于SVN的理解,也不过是知道运行原理,能满足工作里一些简单的代码版本控制罢了.对于Git这个版本控制工具,其实已经听说很长时间了,也明白Git与SVN的工作原理的区别,也一直想入门接触一下,但是苦于下载的一些教材太厚,内容太多,一直也没上手练.正好,这几天事件比较宽裕,于是又找来相关的资料,开始慢慢接触Git的使用,希望

GitHub这么火,程序员你不学学吗? 超简单入门教程 【转载】

本GitHub教程旨在能够帮助大家快速入门学习使用GitHub. 本文章由做全栈攻城狮-写代码也要读书,爱全栈,更爱生活.原创.如有转载,请注明出处. GitHub是什么? GitHub首先是个分布式的版本控制库.通过使用git,可以方便的记录代码版本. 因国内外大量著名的项目,都开始搬迁到github.它又可以称为开源代码社区. github还是学习的好地方,学习优秀的代码. 可对其他项目中有bug的地方进行改进提交,集合众人的力量促进软件的优化改善. github何其火热,截至2015年2月

GitHub这么火,程序员你不学学吗? 超简单入门教程 干货

本GitHub教程旨在能够帮助大家快速入门学习使用GitHub. 本文章由做全栈攻城狮-写代码也要读书,爱全栈,更爱生活.原创.如有转载,请注明出处. GitHub是什么? GitHub首先是个分布式的版本控制库.通过使用git,可以方便的记录代码版本. 因国内外大量著名的项目,都开始搬迁到github.它又可以称为开源代码社区. github还是学习的好地方,学习优秀的代码. 可对其他项目中有bug的地方进行改进提交,集合众人的力量促进软件的优化改善. github何其火热,截至2015年2月

【VB超简单入门】一、写在前面

每本书的前面总得写点什么,到我这里也自然不能免俗,前言这东西“存在即合理”,所以就随便写一点咯~ 首先这本书是给从未接触过编程的童鞋准备的,由于我学识疏浅,对VB也只是一知半解所以也只能讲一点点最基础的知识,入门之后便可以自由学习更高级的东西了~ 编程其实并不难,有很多人一看到屏幕上密密麻麻的代码就被吓呆了= =… 也有很多童鞋问我编程是不是得背很多代码= =…其实根本不用背,编程涉及的单词都是很简单的,高中的英语水平基本是可以胜任的,当然如果英语水平足够高的话可以直接阅读英文原版手册那就是更好

【VB超简单入门】二、知识准备

在开始编程之前,需要先熟悉一下各种操作和术语,以后学习编程才能得心应手. 首先最重要的操作当然就是-电脑的开机关机啦~(开个玩笑哈哈),必须掌握软件的安装和卸载,还有能编写批处理程序对平时的使用也是很有帮助的. 关于各种操作列个表~~ (由于时间关系,先列出相关点,详细操作以后我会慢慢补充~) l 查看.编辑注册表:使用regedit.exe修改系统注册表,我们写程序有时需要将程序的相关配置保存到注册表中,学会修改注册表才能帮助调试程序 l 各种文件操作:相信这个大家都会了吧~~就是复制.剪切.

Express4+Mongodb超简单入门实例

开始前,请确保mongodb已经能正常工作,安装教程:windows下MongoDB的安装及配置 , 请自行安装配置.下面进入正文: 第一步:命令行创建数据库.表,并插入一条数据 命令如下: //创建数据库 use blog //创建一张表,并插入一条数据 db.users.insert({"name":"zhangangs","emali":"[email protected]","age":"

【VB超简单入门】三、开始编程

接下来要进入正题了!同学们要认真看咯~ 第一步:安装VB开发IDE 在这里我推荐大家安装的是VB迷你版,现在大多数同学使用win7,这个版本可以在win7上运行的妥妥的~ 下载链接:http://pan.baidu.com/s/1c1EnV5Q (这里说明一下哈,这个版本提供给大家下载仅供用于学习,请大家购买正版支持微软哈~~) 打开之后是这样子的~ 上图~ 然后一直点下一步就好啦~ 选择安装组件,建议全选 第二步:打开VB新建工程 安装完成之后运行VB,界面如下图: 新建工程,选择“标准EXE

Selenium超简单入门【转】

import org.openqa.selenium.By;import org.openqa.selenium.WebDriver;import org.openqa.selenium.WebElement;import org.openqa.selenium.chrome.ChromeDriver; /** * 这段程序演示了:借助 selenium,启动 chrome浏览器,并登录QQ邮箱的过程 * * @author lizeyang * */public class SeleniumU