Django高级篇一RESTful架构及API设计

  • Post author:
  • Post category:其他


一、什么是RESTful架构?

    通过互联网通信,建立在分布式体系上"客户端/服务器模式”的互联网软件,具有高并发和高延时的特点。
简单的来说,就是用开发软件的模式开发网站。网站开发,完全可以采用软件开发的模式。
但是传统上,软件和网络是两个不同的领域,很少有交集;软件开发主要针对单机环境,网络则主要研究系统之间的通信。
互联网的兴起,使得这两个领域开始融合,现在我们必须考虑,如何开发在互联网环境中使用的软件。
    RESTful架构,就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。

二、RESTful架构

1)起源
    REST这个词,是Roy Thomas Fielding在他2000年的博士论文中提出的。
    (Fielding,HTTP协议(1.0版和1.1版)的主要设计者、Apache服务器软件的作者之一)Fielding将他对互联网软件的架构原则,
    定名为REST,即Representational State Transfer的缩写。我对这个词组的理解是"表现层状态转化"。
    如果一个架构符合REST原则,就称它为RESTful架构。

2)名称
    Fielding将他对互联网软件的架构原则,定名为REST,即Representational State Transfer的缩写。
    我对这个词组的翻译是"表现层状态转化"。如果一个架构符合REST原则,就称它为RESTful架构。
    要理解RESTful架构,最好的方法就是去理解Representational State Transfer这个词组到底是什么意思,
    它的每一个词代表了什么涵义。如果你把这个名称搞懂了,也就不难体会REST是一种什么样的设计。    
    
3)资源(Resource)
  REST的名称"表现层状态转化"中,省略了主语。"表现层"其实指的是"资源"(Resources)的"表现层"。
  资源,网络上的任何一个图片,一组数据,一首歌曲都是资源。你可以通过一个特定的URL指向它,
    如果你想获取这个资源,访问它对应的URL就可以了。而在RESTful中,上网就是,互联网上各种资源的互动。
  
4)表现层(Representation)
  "资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。
    比如,文本可以用txt格式表现,也可以用HTML格式、XML格式、JSON格式表现,
    甚至可以采用二进制格式;图片可以用JPG格式表现,也可以用PNG格式表现。
  URI只代表资源的实体,不代表它的形式。严格地说,有些网址最后的".html"后缀名是不必要的,
    因为这个后缀名表示格式,属于"表现层"范畴,而URI应该只代表"资源"的位置。它的具体表现形式,
    应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对"表现层"的描述。

5)状态转化(State Transfer)
  访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。
    互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,
    必须通过某种手段,让服务器端发生"状态转化"(State Transfer)。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。
  客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。
    它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。

6)总结
  综合上面的解释,我们总结一下什么是RESTful架构:
  1)每一个URI代表一种资源;
  2)客户端和服务器之间,传递这种资源的某种表现层;
  3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"

三、restful的设计误区

1)URI不应该有动词,动词应该放在HTTP协议中。

举例来说,某个URI是/posts/show/1,其中show是动词,这个URI就设计错了,正确的写法应该是/posts/1,然后用GET方法表示show。
  如果某些动作是HTTP动词表示不了的,你就应该把动作做成一种资源。比如网上汇款,从账户1向账户2汇款500元,错误的URI是:

错误:
    POST /accounts/1/transfer/500/to/2
正确:
    正确的写法是把动词transfer改成名词transaction,资源不能是动词,但是可以是一种服务:
    POST /transaction HTTP/1.1
    Host: 127.0.0.1
    from=1&to=2&amount=500.00

2)另一个误区,url加入版本号

错误:
    http://www.example.com/app/1.0/foo
    http://www.example.com/app/1.1/foo
    http://www.example.com/app/2.0/foo
正确:
    因为不同的版本,可以理解成同一种资源的不同表现形式,所以应该采用同一个URI。
    版本号可以在HTTP请求头信息的Accept字段中进行区分(参见Versioning REST Services):
    Accept: vnd.example-com.foo+json; version=1.0
    Accept: vnd.example-com.foo+json; version=1.1
    Accept: vnd.example-com.foo+json; version=2.0

*注,虽说restfull规范建议版本号放在请求头而不是url里,但事实上为了使用方便,大多数开发者还是喜欢把版本号放在url上,这样容易直观区分

四、Restful API设计指南

1)API与用户的通信协议,总是使用

HTTPs协议

2)域名设置

应该尽量将API部署在专用域名之下。
https://api.example.com
如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。 
https://example.org/api/

3)版本号

应该将API的版本号放入URL。
https://api.example.com/v1/

另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。

Github

采用这种做法。

4)url 路径

路径又称"终点"(endpoint),表示API的具体网址。在RESTful架构中,每个网址代表一种资源(resource),
所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。
一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。
举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。  
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

5)HTTP动词。

常用的HTTP动词有下面五个(括号里是对应的SQL命令)。

对于资源的具体操作类型,由HTTP动词表示。

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

不常用的HTTP动词。

HEAD:获取资源的元数据。
OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。

举例说明

GET /zoos:列出所有动物园
POST /zoos:新建一个动物园
GET /zoos/ID:获取某个指定动物园的信息
PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals:列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

6)过滤信息。如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。

常见的过滤参数
?limit=10:指定返回记录的数量
?offset=10:指定返回记录的开始位置。
?page=2&per_page=100:指定第几页,以及每页的记录数。
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
?animal_type_id=1:指定筛选条件

7)状态码。服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。

*    200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。    
     201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
     202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
     204 NO CONTENT - [DELETE]:用户删除数据成功。
*    400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
     401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
*    403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
*    404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
     406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
     410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
     422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
*    500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

8)错误处理(Error handling)如果状态码是4xx,就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。

{
    error: "Invalid API key"
}

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

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

10)Hypermedia API

RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。
比如,当用户向api.example.com的根目录发出请求,会得到这样一个文档。

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

上面代码表示,文档中有一个link属性,用户读取这个属性就知道下一步该调用什么API了。

rel表示这个API与当前网址的关系(collection关系,并给出该collection的网址),
href表示API的路径,title表示API的标题,type表示返回类型。
Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。

{
  "current_user_url": "https://api.github.com/user",
  "authorizations_url": "https://api.github.com/authorizations",
  // ...
}

从上面可以看到,如果想获取当前用户的信息,应该去访问

api.github.com/user

,然后就得到了下面结果。

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

五、Django rest framework实践

实战链接:http://www.cnblogs.com/alex3714/articles/7131523.html

文章链接:https://www.cnblogs.com/alex3714/articles/6808013.html

转载于:https://www.cnblogs.com/linu/p/9727057.html