RESTFRAMEWORK Django Rest Framework

其他 2018-06-25 10:53:46 阅读次数: 2
 

Django Rest Framework

 

一. 什么是RESTful 

  • REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
  • REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
  • 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

二. RESTful API设计

  • API与用户的通信协议，总是使用HTTPs协议。
  • 域名 
    • https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
    • https://example.org/api/                        API很简单
  • 版本
    • URL，如：https://api.example.com/v1/
    • 请求头                                                  跨域时，引发发送多次请求
  • 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
    • https://api.example.com/v1/employees
  • method
    • GET      ：从服务器取出资源（一项或多项）
    • POST    ：在服务器新建一个资源
    • PUT      ：在服务器更新资源（客户端提供改变后的完整资源）
    • PATCH  ：在服务器更新资源（客户端提供改变的属性）
    • DELETE ：从服务器删除资源
  • 过滤，通过在url上传参的形式传递搜索条件
    • https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
    • https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
    • https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
    • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
    • https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
  • 状态码
      常用状态码列表
  • 错误处理，状态码是4xx时，应返回错误信息，error当做key。
    1
    2
    3
    {
         error:  "Invalid API key"
    }
  • 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范。
    1
    2
    3
    4
    5
    6
    GET  / collection：返回资源对象的列表（数组）
    GET  / collection / resource：返回单个资源对象
    POST  / collection：返回新生成的资源对象
    PUT  / collection / resource：返回完整的资源对象
    PATCH  / collection / resource：返回完整的资源对象
    DELETE  / collection / resource：返回一个空文档
  • Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
    1
    2
    3
    4
    5
    6
    { "link" : {
       "rel" :    "collection https://www.example.com/zoos" ,
       "href" :   "https://api.example.com/zoos" ,
       "title" :  "List of zoos" ,
       "type" :   "application/vnd.yourformat+json"
    }}

　　摘自：http://www.ruanyifeng.com/blog/2014/05/restful_api.html 

三. 基于Django实现

路由系统：

1
2
3
urlpatterns  =  [
     url(r '^users' , Users.as_view()),
]

CBV视图：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
from  django.views  import  View
from  django.http  import  JsonResponse
 
class  Users(View):
     def  get( self , request,  * args,  * * kwargs):
         result  =  {
             'status' :  True ,
             'data' :  'response data'
         }
         return  JsonResponse(result, status = 200 )
 
     def  post( self , request,  * args,  * * kwargs):
         result  =  {
             'status' :  True ,
             'data' :  'response data'
         }
         return  JsonResponse(result, status = 200 ) 

四. 基于Django Rest Framework框架实现

1. 基本流程

url.py

1
2
3
4
5
6
from  django.conf.urls  import  url, include
from  web.views.s1_api  import  TestView
 
urlpatterns  =  [
     url(r '^test/' , TestView.as_view()),
]

views.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
from  rest_framework.views  import  APIView
from  rest_framework.response  import  Response
 
 
class  TestView(APIView):
     def  dispatch( self , request,  * args,  * * kwargs):
         """
         请求到来之后，都要执行dispatch方法，dispatch方法根据请求方式不同触发 get/post/put等方法
         
         注意：APIView中的dispatch方法有好多好多的功能
         """
         return  super ().dispatch(request,  * args,  * * kwargs)
 
     def  get( self , request,  * args,  * * kwargs):
         return  Response( 'GET请求，响应内容' )
 
     def  post( self , request,  * args,  * * kwargs):
         return  Response( 'POST请求，响应内容' )
 
     def  put( self , request,  * args,  * * kwargs):
         return  Response( 'PUT请求，响应内容' )

上述是rest framework框架基本流程，重要的功能是在APIView的dispatch中触发。

2.  认证和授权

a. 用户url传入的token认证

  urls.py
  views.py

b. 请求头认证

  urls.py
  views.py

c. 多个认证规则

  urls.py
  views.py

d. 认证和权限

  urls.py
  views.py

e. 全局使用

上述操作中均是对单独视图进行特殊配置，如果想要对全局进行配置，则需要再配置文件中写入即可。

  settings.py
  urls.py
  views.py

3. 用户访问次数/频率限制

a. 基于用户IP限制访问频率

  urls.py
  views.py

b. 基于用户IP显示访问频率（利于Django缓存）

  settings.py
  urls.py
  views.py

c. view中限制请求频率

  settings.py
  urls.py
  views.py

d. 匿名时用IP限制+登录时用Token限制

  settings.py
  urls.py
  views.py

e. 全局使用

  settings

4. 版本

a. 基于url的get传参方式

如：/users?version=v1

  settings.py
  urls.py
  views.py

b. 基于url的正则方式

如：/v1/users/

  settings.py
  urls.py
  views.py

c. 基于 accept 请求头方式

如：Accept: application/json; version=1.0

  settings.py
  urls.py
  views.py

d. 基于主机名方法

如：v1.example.com

  settings.py
  urls.py
  views.py

e. 基于django路由系统的namespace

如：example.com/v1/users/

  settings.py
  urls.py
  views.py

f. 全局使用

  settings.py

5. 解析器（parser） 

根据请求头 content-type 选择对应的解析器就请求体内容进行处理。

a. 仅处理请求头content-type为application/json的请求体

  urls.py
  views.py

b. 仅处理请求头content-type为application/x-www-form-urlencoded 的请求体

  urls.py
  views.py

c. 仅处理请求头content-type为multipart/form-data的请求体

  urls.py
  views.py
  upload.html

d. 仅上传文件

  urls.py
  views.py
  upload.html

e. 同时多个Parser

当同时使用多个parser时，rest framework会根据请求头content-type自动进行比对，并使用对应parser

  urls.py
  views.py

f. 全局使用

  settings.py
  urls.py
  views.py

注意：个别特殊的值可以通过Django的request对象 request._request 来进行获取

6. 序列化

序列化用于对用户请求数据进行验证和数据进行序列化。

a. 自定义字段

  urls.py
  views.py

b. 基于Model自动生成字段

  urls.py
  views.py

c. 生成URL

  urls.py
  views.py

d. 自动生成URL

  urls.py
  views.py

7. 分页

a. 根据页码进行分页

  urs.py
  views.py

b. 位置和个数进行分页

  urls.py
  views.py

c. 游标分页

  urls.py
  views.py

8. 路由系统

a. 自定义路由

  urls.py
  views.py

b. 半自动路由

  urls.py
  views.py

c. 全自动路由

  urls.py
  views.py

9. 视图

a. GenericViewSet

  urls.py
  views.py

b. ModelViewSet（自定义URL）

  urls.py
  views.py

c. ModelViewSet（rest framework路由）

  urls.py
  views.py

10. 渲染器

根据 用户请求URL 或 用户可接受的类型，筛选出合适的 渲染组件。
用户请求URL：

  • http://127.0.0.1:8000/test/?format=json
  • http://127.0.0.1:8000/test.json

用户请求头：

  • Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8

a. json

访问URL：

  • http://127.0.0.1:8000/test/?format=json
  • http://127.0.0.1:8000/test.json
  • http://127.0.0.1:8000/test/ 
  urls.py
  views.py

b. 表格

访问URL：

  • http://127.0.0.1:8000/test/?format=admin
  • http://127.0.0.1:8000/test.admin
  • http://127.0.0.1:8000/test/ 
  views.py

c. Form表单

访问URL：

  • http://127.0.0.1:8000/test/?format=form
  • http://127.0.0.1:8000/test.form
  • http://127.0.0.1:8000/test/ 
  views.py

d. 自定义显示模板

访问URL：

  • http://127.0.0.1:8000/test/?format=html
  • http://127.0.0.1:8000/test.html
  • http://127.0.0.1:8000/test/ 
  urls.py
  views.py
  userdetail.html

e. 浏览器格式API+JSON

访问URL：

  • http://127.0.0.1:8000/test/?format=api
  • http://127.0.0.1:8000/test.api
  • http://127.0.0.1:8000/test/ 
  views.py

注意：如果同时多个存在时，自动根据URL后缀来选择渲染器。

 
 

一. 什么是RESTful 

  • REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
  • REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
  • 所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
  • 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

二. RESTful API设计

  • API与用户的通信协议，总是使用HTTPs协议。
  • 域名 
    • https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
    • https://example.org/api/                        API很简单
  • 版本
    • URL，如：https://api.example.com/v1/
    • 请求头                                                  跨域时，引发发送多次请求
  • 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
    • https://api.example.com/v1/employees
  • method
    • GET      ：从服务器取出资源（一项或多项）
    • POST    ：在服务器新建一个资源
    • PUT      ：在服务器更新资源（客户端提供改变后的完整资源）
    • PATCH  ：在服务器更新资源（客户端提供改变的属性）
    • DELETE ：从服务器删除资源
  • 过滤，通过在url上传参的形式传递搜索条件
    • https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
    • https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
    • https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
    • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
    • https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
  • 状态码
      常用状态码列表
  • 错误处理，状态码是4xx时，应返回错误信息，error当做key。
    1
    2
    3
    {
         error:  "Invalid API key"
    }
  • 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范。
    1
    2
    3
    4
    5
    6
    GET  / collection：返回资源对象的列表（数组）
    GET  / collection / resource：返回单个资源对象
    POST  / collection：返回新生成的资源对象
    PUT  / collection / resource：返回完整的资源对象
    PATCH  / collection / resource：返回完整的资源对象
    DELETE  / collection / resource：返回一个空文档
  • Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
    1
    2
    3
    4
    5
    6
    { "link" : {
       "rel" :    "collection https://www.example.com/zoos" ,
       "href" :   "https://api.example.com/zoos" ,
       "title" :  "List of zoos" ,
       "type" :   "application/vnd.yourformat+json"
    }}

　　摘自：http://www.ruanyifeng.com/blog/2014/05/restful_api.html 

三. 基于Django实现

路由系统：

1
2
3
urlpatterns  =  [
     url(r '^users' , Users.as_view()),
]

CBV视图：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
from  django.views  import  View
from  django.http  import  JsonResponse
 
class  Users(View):
     def  get( self , request,  * args,  * * kwargs):
         result  =  {
             'status' :  True ,
             'data' :  'response data'
         }
         return  JsonResponse(result, status = 200 )
 
     def  post( self , request,  * args,  * * kwargs):
         result  =  {
             'status' :  True ,
             'data' :  'response data'
         }
         return  JsonResponse(result, status = 200 ) 

四. 基于Django Rest Framework框架实现

1. 基本流程

url.py

1
2
3
4
5
6
from  django.conf.urls  import  url, include
from  web.views.s1_api  import  TestView
 
urlpatterns  =  [
     url(r '^test/' , TestView.as_view()),
]

views.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
from  rest_framework.views  import  APIView
from  rest_framework.response  import  Response
 
 
class  TestView(APIView):
     def  dispatch( self , request,  * args,  * * kwargs):
         """
         请求到来之后，都要执行dispatch方法，dispatch方法根据请求方式不同触发 get/post/put等方法
         
         注意：APIView中的dispatch方法有好多好多的功能
         """
         return  super ().dispatch(request,  * args,  * * kwargs)
 
     def  get( self , request,  * args,  * * kwargs):
         return  Response( 'GET请求，响应内容' )
 
     def  post( self , request,  * args,  * * kwargs):
         return  Response( 'POST请求，响应内容' )
 
     def  put( self , request,  * args,  * * kwargs):
         return  Response( 'PUT请求，响应内容' )

上述是rest framework框架基本流程，重要的功能是在APIView的dispatch中触发。

2.  认证和授权

a. 用户url传入的token认证

  urls.py
  views.py

b. 请求头认证

  urls.py
  views.py

c. 多个认证规则

  urls.py
  views.py

d. 认证和权限

  urls.py
  views.py

e. 全局使用

上述操作中均是对单独视图进行特殊配置，如果想要对全局进行配置，则需要再配置文件中写入即可。

  settings.py
  urls.py
  views.py

3. 用户访问次数/频率限制

a. 基于用户IP限制访问频率

  urls.py
  views.py

b. 基于用户IP显示访问频率（利于Django缓存）

  settings.py
  urls.py
  views.py

c. view中限制请求频率

  settings.py
  urls.py
  views.py

d. 匿名时用IP限制+登录时用Token限制

  settings.py
  urls.py
  views.py

e. 全局使用

  settings

4. 版本

a. 基于url的get传参方式

如：/users?version=v1

  settings.py
  urls.py
  views.py

b. 基于url的正则方式

如：/v1/users/

  settings.py
  urls.py
  views.py

c. 基于 accept 请求头方式

如：Accept: application/json; version=1.0

  settings.py
  urls.py
  views.py

d. 基于主机名方法

如：v1.example.com

  settings.py
  urls.py
  views.py

e. 基于django路由系统的namespace

如：example.com/v1/users/

  settings.py
  urls.py
  views.py

f. 全局使用

  settings.py

5. 解析器（parser） 

根据请求头 content-type 选择对应的解析器就请求体内容进行处理。

a. 仅处理请求头content-type为application/json的请求体

  urls.py
  views.py

b. 仅处理请求头content-type为application/x-www-form-urlencoded 的请求体

  urls.py
  views.py

c. 仅处理请求头content-type为multipart/form-data的请求体

  urls.py
  views.py
  upload.html

d. 仅上传文件

  urls.py
  views.py
  upload.html

e. 同时多个Parser

当同时使用多个parser时，rest framework会根据请求头content-type自动进行比对，并使用对应parser

  urls.py
  views.py

f. 全局使用

  settings.py
  urls.py
  views.py

注意：个别特殊的值可以通过Django的request对象 request._request 来进行获取

6. 序列化

序列化用于对用户请求数据进行验证和数据进行序列化。

a. 自定义字段

  urls.py
  views.py

b. 基于Model自动生成字段

  urls.py
  views.py

c. 生成URL

  urls.py
  views.py

d. 自动生成URL

  urls.py
  views.py

7. 分页

a. 根据页码进行分页

  urs.py
  views.py

b. 位置和个数进行分页

  urls.py
  views.py

c. 游标分页

  urls.py
  views.py

8. 路由系统

a. 自定义路由

  urls.py
  views.py

b. 半自动路由

  urls.py
  views.py

c. 全自动路由

  urls.py
  views.py

9. 视图

a. GenericViewSet

  urls.py
  views.py

b. ModelViewSet（自定义URL）

  urls.py
  views.py

c. ModelViewSet（rest framework路由）

  urls.py
  views.py

10. 渲染器

根据 用户请求URL 或 用户可接受的类型，筛选出合适的 渲染组件。
用户请求URL：

  • http://127.0.0.1:8000/test/?format=json
  • http://127.0.0.1:8000/test.json

用户请求头：

  • Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8

a. json

访问URL：

  • http://127.0.0.1:8000/test/?format=json
  • http://127.0.0.1:8000/test.json
  • http://127.0.0.1:8000/test/ 
  urls.py
  views.py

b. 表格

访问URL：

  • http://127.0.0.1:8000/test/?format=admin
  • http://127.0.0.1:8000/test.admin
  • http://127.0.0.1:8000/test/ 
  views.py

c. Form表单

访问URL：

  • http://127.0.0.1:8000/test/?format=form
  • http://127.0.0.1:8000/test.form
  • http://127.0.0.1:8000/test/ 
  views.py

d. 自定义显示模板

访问URL：

  • http://127.0.0.1:8000/test/?format=html
  • http://127.0.0.1:8000/test.html
  • http://127.0.0.1:8000/test/ 
  urls.py
  views.py
  userdetail.html

e. 浏览器格式API+JSON

访问URL：

  • http://127.0.0.1:8000/test/?format=api
  • http://127.0.0.1:8000/test.api
  • http://127.0.0.1:8000/test/ 
  views.py

注意：如果同时多个存在时，自动根据URL后缀来选择渲染器。

猜你喜欢

转载自www.cnblogs.com/leigepython/p/9223155.html
今日推荐
中国码农的“35岁魔咒”
蘭雅 CorelDRAW 插件 2024.5.1 国际劳动节版，免费下载
Arc Browser for Windows 1.0 正式 GA
90后程序员开发视频搬运软件、不到一年获利超 700 万，结局很刑！
《美国对全球网络空间安全与发展的威胁和破坏》报告发布
周排行
[编程题]学英语
[codeforces 1288A] Deadline 约数+模
Python的web开发
Docker在Centos 7上的部署
python编码
解决Ubuntu16.04 fatal error: json/json.h: No such file or directory
mysql并发插入
rest接口如何适应jsonp的方案
linux 终端上网设置
高数——等号两边同时求导、积分的解释
每日归档
更多
2024-05-04(7)
2024-05-03(19)
2024-05-02(0)
2024-05-01(4)
2024-04-30(1)
2024-04-29(40)
2024-04-28(0)
2024-04-27(56)
2024-04-26(39)
2024-04-25(22)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022