Restful规范-开发api接口

web服务交互

咱们在浏览器中能看到的每一个网站,都是一个web服务。那么咱们在提供每一个web服务的时候,css

  都须要先后端交互,先后端交互就必定有一些实现方案,咱们一般叫web服务交互方案。html

  目前主流的三种web服务交互方案:web

    -- REST ( Representational State Transfer)表述性状态转移编程

    -- SOAP (Simple Object Access Protocol) 简单的对象访问协议json

    -- XML-RPC (XML Remote Procedure Call)基于XML的远程过程调用后端

  XML-RPC是经过XML将调用函数封装,并使用HTTP协议做为传送机制。api

  后来在新的功能不断被引入下,这个标准慢慢演变成为今日的SOAP协定。浏览器

  SOAP服务则是以自己所定义的操做集,来访问网络上的资源。服务器

  SOAP也是基于XML的,可是它不仅限于HTTP协议的传输,包括TCP协议,UDP协议均可以传输。restful

  REST是Roy Thomas Fielding博士于2000年在他的博士论文里提出来的。

  REST相比SOAP更加简洁,性能和开发效率也有突出的优点。

  咱们今天主要说一下这个REST,如今愈来愈多的web服务开始采用REST风格设计和实现。

  例如,amazon.com提供接近REST风格的Web服务进行图书查找;雅虎提供的Web服务也是REST风格的。

  咱们接下来要学的框架也是遵循REST风格的,那么咱们来看下它究竟是个什么样的风格,

  了解了它是什么后,咱们看下它的优势是什么,咱们为何用它。

理解REST

若是咱们想要理解restful,就要理解Representational State Transfer这个词组的意思,表征性状态转移。

  这里所说的表征性,其实指的就是资源。一般咱们称为资源状态转移。

什么是资源

  任何事物,只要有被引用到的必要,它就是一个资源。

  咱们在浏览器中看到的文本,视频,图片等等都是资源。这些都是实实在在存在的实体。

  资源能够是一个实体,也能够是抽象概念。

  好比说吧:

    -- 李杰的我的信息

    -- 李军的手机号

    -- 李杰跟李军的潜在关系

  这些都是资源,能够是实体好比我的信息,手机号。也能够是抽象的概念,好比两我的的关系......

  那么在咱们的网络中,咱们要引用资源,资源必定要有一个标识,在web中的惟一标识就是URI,

  URI咱们不常据说,咱们常常用URL,那么二者区别是什么呢~

什么是URI,URL

  URI 统一资源标志符。

  URL 统一资源定位符。

  URI是给咱们的资源进行标识的,URL是描述咱们资源地址的。

  好比说咱们每一个人都有名字和身份证,名字可能重名,可是身份证是惟一的,

  那么身份证号就能够是咱们的URI,标识咱们每一个人,也能够说标识咱们每一个资源。

  咱们能够经过身份证号找到Alex,也能够经过下面这种方式找到他.....

  Alex的住址协议://地球/中国/屌丝省/屌丝市/寡妇村/250号街道/250号/Alex

  这个就是咱们的URL,咱们经过这两种方式均可以找到咱们的资源,

  其实咱们的URL能够说是URI的子集,经过定位的方式实现的URI。

  这是咱们资源的定位有了资源的地址后,咱们要去访问资源,那么咱们要经过什么方式去访问呢

统一资源接口

  如今咱们能够经过URL去访问到资源,那么咱们对资源会有不少不一样的操做,增删改查,

  之前咱们可能会为了这个增长新设计一个URL,而后这个URL就是对数据进行增长的,

  还会为了更新和删除分别设计一个URL,如今咱们不用了,咱们只有一个URL,

  而后根据HTTP请求方式的不一样,对资源进行不一样的操做,这个就是是统一资源接口。

  咱们必定要遵循HTTP请求方法的语义,也就是说POST请求就在新增数据等....

资源的表述

  资源的表述其实就是资源的展示形式,咱们客户端和服务端传输的都是资源的表述,而不是资源自己。

  例如文本资源能够采用html、xml、json等格式,图片可使用PNG或JPG展示出来。

  那么客户端如何知道服务端提供哪一种表述形式呢?

  能够经过HTTP内容协商,客户端能够经过Accept头请求一种特定格式的表述,服务端则经过Content-Type告诉客户端资源的表述形式。

  这些资源的表述呈如今页面上,就是咱们说的资源状态。

状态转移

  咱们在看页面的时候,从当前资源的表述(也能够说状态或者表现层)会跳转到其余的资源状态。

  服务端经过超媒体告诉客户端当前状态有哪些后续状态能够进入。

  这些相似"下一页"之类的连接起的就是这种推动状态的做用——指引你如何从当前状态进入下一个可能的状态。

总结 

  能够得知REST风格的特色以下:

  (1)在web中,只要有被引用的必要都叫资源。

  (2)每一个URI表明一个资源,独一无二的。

  (3)客户端经过HTTP的方法,对服务器端资源进行操做;

  (4)客户端和服务器之间,传递这种资源的某种表现层;

  (5)经过超连接的指引,实现"表现层状态转移"。

RESTful

 
  若是一个架构符合REST的约束条件和原则,咱们就称它为RESTful架构。

  一种软件的架构风格,设计风格, 为客户端和服务端的交互提供一组设计原则和约束条件。

restful规范

一 面向资源编程
  每一个URL表明一种资源,URL中尽可能不要用动词,要用名词。

二 根据method不一样,进行不一样的操做
  GET/POST/PUT/DELETE/PATCH

三 在URL中体现版本
  https://www.bootcss.com/v1/mycss

  https://v1.bootcss.com/mycss

四 在URL中体现是不是API
  https://www.bootcss.com/api/mycss

  https://api.bootcss.com/mycss

五 在URL中的过滤条件
  https://www.bootcss.com/v1/mycss?page=3

六 尽可能使用HTTPS
  https://www.bootcss.com/v1/mycss

七 响应时设置状态码
  1** 信息,服务器收到请求,须要请求者继续执行操做

  2** 成功,操做被成功接收并处理

  3** 重定向,须要进一步的操做以完成请求

  4** 客户端错误,请求包含语法错误或没法完成请求

  5** 服务器错误,服务器在处理请求的过程当中发生了错误

八 返回值
  GET请求 返回查到全部或单条数据

  POST请求 返回新增的数据

  PUT请求 返回更新数据

  PATCH请求 局部更新 返回更新整条数据

  DELETE请求 返回值为空

九 返回错误信息
  返回值携带错误信息

十 Hypermedia API
  若是遇到须要跳转的状况 携带调转接口的URL

  ret = {
code: 1000,
data:{
id:1,
name:'小强',
depart_id:http://addmoney.top/api/v1/depart/8/ } }

相关文章
相关标签/搜索