14-认识DjangoRESTframework

了解DjangoRESTframework

  现在流行的前后端分离Web应用模式,然而在开发Web应用中,有两种应用模式:1、前后端不分离 2、前后端分离。

1、前后端不分离

  在前后端不分离中,前端看见的效果都是由后端渲染或者重定向,然后发给前端的。即前后端耦合度高。这种开发模式比较适合纯网页应用,但是后端对接app的时候,app可能不需要后端返回的HTML网页,而是数据本身。所以后端的接口并不适合前端app应用,为了对接app后端还需另一套接口。

2、前后端分离

   在前后端分离的应用中,后端返回前端需要的数据,不渲染HTML页面。用户先看到效果,从后端请求的数据加载到前端中。网页和app都有自己处理网页的方式,在前后端分离的应用模式中,前端与后端的耦合度相对较低。在前后端分离的应用模式中,我们通常将后端开发的每个视图称为一个接口,或者API,前端通过访问接口来对数据进行增删改查。

3、认识RESTful

在前后端分离的应用模式里,后端API接口定义

举个例子:后端数据库中保存了商品的信息,前端需要对商品数据进行增删改查,那相应的每个操作需要提供一个API接口:

  1、POST 增加商品

  2、POST 删除商品

  3、POST 修改商品

  4、GET 查询商品

  因为每一个接口与请求方式对于每一个开发者来说都可能不一样,因此存在了一种统一的定义方式,被广大开发人员接收和普遍采用的APIRESTful设计风格。

RESTful设计方法

1、域名:

尽量把API部署在专用域名下:

https://api.example.com

如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下:

https://example.org/api/

2、版本(Versioning)

将API的版本号放入URL中

http://www.example.com/api/1.0/foo

http://www.example.com/api/1.1/foo

http://www.example.com/api/2.0/foo

  另一种方法就是将版本号放在HTTP头信息中,放入URL方便和直观。github就采用的是这种方法。不同版本就是同一资源的不同表现形式,所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分。

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

 3、路径(Endpoint)

  路径又称终点(endpoint),表示API的具体网址,每个网址代表一种资源。资源作为网址,只能是名词,不能是动词,而且名词与数据库表名对应,对于简洁的结构,始终用名词,此外利用HTTP方法可以分离网址中的资源名称的操作。API中的名词应该使用复数。无论子资源或者所有资源。就像下面例子,获取产品API可以这样定义。

获取单个产品:http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品: http://127.0.0.1:8080/AppName/rest/products

3、HTTP动词

对于资源的具体操作类型,由HTTP动词表示,常用的HTTP动词有四个(括号里是对应SQL命令)

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

还有三个不常用的HTTP动词: PATCH(UPDATE):在服务器更新(更新)资源(客户端提供改变的属性)。 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:删除某个指定动物园的指定动物

4、过滤信息(Filtering)

记录的东西多的话,API应该提供参数,过滤返回结果,服务器不可能全部返回。

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

参数设计允许冗余,即API路径和URL参数偶尔有重复,比如GET /zoos/ID/animalsGET /animals?zoo_id=ID 的含义是相同的。

6、状态码*(Status Codes)

服务器向客户端返回的状态码和提示信息,常见的以下信息:(方括号是该状态码对应的HTTP动词)

200 OK - [GET]:服务器成功返回用户请求的数据
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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

7、错误处理(Error handling)

如果状态码是4xx,服务器就应该向用户返回出错信息。一般来说,返回信息中将error作为键名,出错信息作为键值就可以了。

{
    error: "Invalid API key"
}

8、返回结果

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

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

9、超媒体(Hypermedia API)

  RESTful API最好做到Hypermedia(即返回结果中提供链接,连向其他API方法),使得用户不查文档,也知道下一步做啥。比如githubAPI就是这种设计,访问api.github.com会得到一个所有可用的API的网址列表:

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

从这里可以看出,如果想获取当前用户信息,就应该访问第一个url,然后就得到下面结果。

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

上面的显示,服务器给出了提示信息,以及文档的地址。

10、其他

服务器返回的数据格式,应该尽量使用JSON,避免使用XML

原文地址:https://www.cnblogs.com/lishuntao/p/11723215.html