RESTFful规范介绍
熟悉RESTful API(接口)开发
RESTful是个啥?
规范
表现层状态转化
将传统的软件开发架构与通信协议做融合
用HTTP协议中的 请求方法 来表示增删改查四个动作
GET: 获取资源
POST: 创建资源
PUT:更新资源
DELETE:删除资源
RESTful优势:
以图书的增删改查为例
/books/ GET:获取图书信息
/books/add/ POST:新增图书
/books/1/edit/ POST: 编辑图书
/books/1/del/ POST: 删除图书
/books/ GET:查看所有的图书
/books/ POST: 创建一本书
/books/1/ PUT:编辑图书
/books/1/ DELETE:删除图书
/books/1
id: 1
title: 《跟MJJ学前端》
publisher: '/publisher/1/'
RESTful设计的误区:
1. URI不要包含动词!
RESTful设计指南
状态码:
进入网址查询
https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#1xx_Informational_response
1xx(信息):收到请求,继续处理
2xx(成功):请求已成功接收,理解和接受
3xx(重定向):需要采取进一步措施才能完成请求
4xx(客户端错误):请求包含错误的语法或无法满足
5xx(服务器错误):服务器无法满足明显有效的请求
1xx信息
100:Continue,收到部分请求,应该继续请求
101:Switch protocols,切换协议,服务器正根据客户端的指示将协议切换为Update或者Upgrade首部列出的协议
2xx成功
200:OK,服务器成功处理请求
201:Created,对于需要服务器创建对象的请求来说,资源已经创建完毕
202:Accepted,请求已经接受,服务器未处理
203:Non-Authoritative Information,服务器成功处理事务,只是实体包含的信息不是来自原始服务器,而是来自资源的副本
204:No Content,响应报文只包含首部和状态行,不包含实体内容
205:Reset Content,浏览器应该重置当前页面的HTML表单
206:Partial Content,部分请求成功
3xx重定向
- 300:Multiple Choices,客户端请求了实际指向多个资源的URL,这个代码和一个选项列表同时返回,用户可以选择希望使用的选项
- 301:Moved Permanently,永久重定向,请求的URL已经移走,响应中应该包含一个Location首部,说明资源新的地址
- 302:Found,临时重定向,客户端可以使用Location首部给出的URL对资源进行临时定位
- 303 See Other 类似于301/302,不同之处在于,如果原来的请求是POST,Location头指定的重定向目标文档应该通过GET提取(HTTP 1.1新)。
- 304 Not Modified 客户端有缓冲的文档并发出了一个条件性的请求(一般是提供If-Modified-Since头表示客户只想比指定日期更新的文档)。服务器告 诉客户,原来缓冲的文档还可以继续使用。
- 305 Use Proxy 客户请求的文档应该通过Location头所指明的代理服务器提取(HTTP 1.1新)。
- 306:这个状态码未使用 永久重定向 改变请求方式
- 307 Temporary Redirect 和302 (Found)相同。许多浏览器会错误地响应302应答进行重定向,即使原来的请求是POST,即使它实际上只能在POST请求的应答是303时才能重定 向。由于这个原因,HTTP 1.1新增了307,以便更加清除地区分几个状态代码:当出现303应答时,浏览器可以跟随重定向的GET和POST请求;如果是307应答,则浏览器只 能跟随对GET请求的重定向。(HTTP 1.1新)
4xx客户端错误
- 400:Bad request,请求出现语法错误。
- 401 Unauthorized 客户试图未经授权访问受密码保护的页面。应答中会包含一个WWW-Authenticate头,浏览器据此显示用户名字/密码对话框,然后在填 写合适的Authorization头后再次发出请求。
- 403 Forbidden 资源不可用。服务器理解客户的请求,但拒绝处理它。通常由于服务器上文件或目录的权限设置导致。
- 404 Not Found 无法找到指定位置的资源。这也是一个常用的应答。
- 405 Method Not Allowed 请求方法(GET、POST、HEAD、DELETE、PUT、TRACE等)对指定的资源不适用。(HTTP 1.1新)
- 406 Not Acceptable 指定的资源已经找到,但它的MIME类型和客户在Accpet头中所指定的不兼容(HTTP 1.1新)。
- 407 Proxy Authentication Required 类似于401,表示客户必须先经过代理服务器的授权。(HTTP 1.1新)
- 408 Request Timeout 在服务器许可的等待时间内,客户一直没有发出任何请求。客户可以在以后重复同一请求。(HTTP 1.1新)
- 409 Conflict 通常和PUT请求有关。由于请求和资源的当前状态相冲突,因此请求不能成功。(HTTP 1.1新)
- 410 Gone 所请求的文档已经不再可用,而且服务器不知道应该重定向到哪一个地址。它和404的不同在于,返回407表示文档永久地离开了指定的位置,而 404表示由于未知的原因文档不可用。(HTTP 1.1新)
- 411 Length Required 服务器不能处理请求,除非客户发送一个Content-Length头。(HTTP 1.1新)
- 412 Precondition Failed 请求头中指定的一些前提条件失败(HTTP 1.1新)。
- 413 Request Entity Too Large 目标文档的大小超过服务器当前愿意处理的大小。如果服务器认为自己能够稍后再处理该请求,则应该提供一个Retry-After头(HTTP 1.1新)。
- 414 Request URI Too Long URI太长(HTTP 1.1新)。
- 416 Requested Range Not Satisfiable 服务器不能满足客户在请求中指定的Range头。(HTTP 1.1新)
5xx服务端错误
- 501 Not Implemented 服务器不支持实现请求所需要的功能。例如,客户发出了一个服务器不支持的PUT请求。
- 502 Bad Gateway 服务器作为网关或者代理时,为了完成请求访问下一个服务器,但该服务器返回了非法的应答。
- 503 Service Unavailable 服务器由于维护或者负载过重未能应答。例如,Servlet可能在数据库连接池已满的情况下返回503。服务器返回503时可以提供一个 Retry-After头。
- 504 Gateway Timeout 由作为代理或网关的服务器使用,表示不能及时地从远程服务器获得应答。(HTTP 1.1新)
- 505 HTTP Version Not Supported 服务器不支持请求中所指明的HTTP版本。(HTTP 1.1新)
对restful 规范的理解
REpresentational State Transfer 直接翻译:表现层状态转移
URL定位资源,用HTTP动词(GET,POST,DELETE,DETC)描述操作
主要分几种: url 根路径 api 版本信息 url 中使用名词,不用动词,推荐使用复数 用http 动词来实现资源的 增删改查 使用正确的 http 状态吗 过滤信息 页数 条数 排序规则 筛选条件 规范返回数据格式 {status:0,data:{}|[],msg:""} 看一个标准的 restful api 应该做到: 1. 看url 就知道操作的资源是什么 2. 看 http method 就知道 操作的动作是什么 3. 看 http status code 就知道操作的结果如何