Django REST framework

一   什么是API与RESTful

二   resrful API

三   基于Django做API

四   Django REST framework 的使用

一   什么是API与RESTful

      api就是接口：

          两个用途：

               - 为别人提供服务

               - 前后端分离

     REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”

     REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态。

     所有的数据，不管是通过网络获取的还是操作数据库（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性。

      对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

二   resrful API

       有下面的一些约束(可以不遵循)

  2.1协议

     API与用户的通信协议，总是使用HTTPs协议。

  2.2域名

     应该尽量将API部署在专用域名之下。 

https://api.example.com

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

https://example.org/api/

   2.3版本信息

       应该将API的版本号放入URL。

https://api.example.com/v1/

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

  2.4路径

    路径又称"终点"（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

2.5 HTTP动词

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

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

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：删除某个指定动物园的指定动物

2.6过滤信息

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

下面是一些常见的参数。

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

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

2.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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

状态码的完全列表参见这里。

2.8错误处理

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

2.9 返回结果

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

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

2.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"
}

上面代码表示，服务器给出了提示信息，以及文档的网址。

2.11 其他：

（1）API的身份认证应该使用OAuth 2.0框架。

（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

三   基于Django做API

    代码如下：

FBV

from django.shortcuts import render,HttpResponse
import  json

# Create your views here.
def users(request):
    response={'code':1000,'data':None}
    response['data']=[
        {'name':'盛松','age':19},
        {'name':'Frank','age':20},

    ]
    return  HttpResponse(json.dumps(response))
def user(request,pk):
    if request.method=="GET":
        return  HttpResponse(json.dumps({'name':'Frank','age':20}))
    elif request.method=="POST":
        return  HttpResponse(json.dumps({'code':1111}))
    elif request.method=='PUT':
        pass
    elif request.method =='DELETE':
        pass

"""demo141 URL Configuration

The `urlpatterns` list routes URLs to views. For more information please see:
    https://docs.djangoproject.com/en/1.11/topics/http/urls/
Examples:
Function views
    1. Add an import:  from my_app import views
    2. Add a URL to urlpatterns:  url(r'^$', views.home, name='home')
Class-based views
    1. Add an import:  from other_app.views import Home
    2. Add a URL to urlpatterns:  url(r'^$', Home.as_view(), name='home')
Including another URLconf
    1. Import the include() function: from django.conf.urls import url, include
    2. Add a URL to urlpatterns:  url(r'^blog/', include('blog.urls'))
"""
from django.conf.urls import url
from django.contrib import admin
from app01 import  views
from app02 import  views as app02_views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^users/', app02_views.users),
    url(r'^user/(d+)', app02_views.user),

]

CBV:

     先走dispatch方法，我们继承父类的dispatch方法，得到的结果要返回。

from django.shortcuts import render,HttpResponse
from django.views import  View
import  json
class UsersView(View):
    def get(self,request):
        response = {'code': 1000, 'data': None}
        response['data']=[
                {'name':'盛松','age':19},
                {'name':'Frank','age':20},
            ]
        return  HttpResponse(json.dumps(response))
class UserView(View):
    def dispatch(self, request, *args, **kwargs):
        ret=super(UserView,self).dispatch(request, *args, **kwargs)
        return  ret
    def get(self,request,pk):
        print(request,type(request))
        return HttpResponse(json.dumps({'name': 'Frank'}))
    def post(self,request,pk):
        print(request,type(request))
        return HttpResponse(json.dumps({'name': 'Frank'}))
    def put(self,request,pk):
        print(request,type(request))
        return HttpResponse(json.dumps({'name': 'Frank'}))
    def delete(self,request,pk):
        print(request,type(request))
        return HttpResponse(json.dumps({'name': 'Frank'}))


# Create your views here.
# def users(request):
#     response={'code':1000,'data':None}
#     response['data']=[
#         {'name':'盛松','age':19},
#         {'name':'Frank','age':20},
#
#     ]
#     return  HttpResponse(json.dumps(response))
# def user(request,pk):
#     if request.method=="GET":
#         return  HttpResponse(json.dumps({'name':'Frank','age':20}))
#     elif request.method=="POST":
#         return  HttpResponse(json.dumps({'code':1111}))
#     elif request.method=='PUT':
#         pass
#     elif request.method =='DELETE':
#         pass
#

"""demo141 URL Configuration

The `urlpatterns` list routes URLs to views. For more information please see:
    https://docs.djangoproject.com/en/1.11/topics/http/urls/
Examples:
Function views
    1. Add an import:  from my_app import views
    2. Add a URL to urlpatterns:  url(r'^$', views.home, name='home')
Class-based views
    1. Add an import:  from other_app.views import Home
    2. Add a URL to urlpatterns:  url(r'^$', Home.as_view(), name='home')
Including another URLconf
    1. Import the include() function: from django.conf.urls import url, include
    2. Add a URL to urlpatterns:  url(r'^blog/', include('blog.urls'))
"""
from django.conf.urls import url
from django.contrib import admin
from app01 import  views
from app02 import  views as app02_views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    # url(r'^users/', app02_views.users),
    # url(r'^user/(d+)', app02_views.user),
    url(r'^user/$', app02_views.UsersView.as_view()),
    url(r'^user/(d+)', app02_views.UserView.as_view()),

]

四   Django REST framework 的使用

  主要是做Token验证  url中as_view里面调用了dispatch方法。

from django.shortcuts import render,HttpResponse
from django.views import  View
import  json
from  rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from  rest_framework.authentication import BaseAuthentication
from app02 import models
from rest_framework.exceptions import APIException
import  hashlib
import  time
class AuthView(APIView):
    authentication_classes=[]
    def get(self,request):
        ret={'code':1000,"msg":None}
        username=request.query_params.get('username')
        password=request.query_params.get('password')
        obj=models.UserInfo.objects.filter(username=username,pwd=password).first()
        if not obj:
            ret['code']=1001
            ret['msg']='用户名或者密码错误'
            return Response(ret)
        ctime=time.time()
        key=" %s | %s"%(ctime,username)
        m=hashlib.md5()
        m.update(key.encode('utf-8'))
        token=m.hexdigest()

        obj.token=token
        obj.save()

        ret['token']=token
        return Response(ret)


class HostView(APIView):
    def get(self,request,*args,**kwargs):
        self.dispatch
        print(request.user)
        print('auth',request.auth)
        return Response('>>>>>>>>')

"""demo141 URL Configuration

The `urlpatterns` list routes URLs to views. For more information please see:
    https://docs.djangoproject.com/en/1.11/topics/http/urls/
Examples:
Function views
    1. Add an import:  from my_app import views
    2. Add a URL to urlpatterns:  url(r'^$', views.home, name='home')
Class-based views
    1. Add an import:  from other_app.views import Home
    2. Add a URL to urlpatterns:  url(r'^$', Home.as_view(), name='home')
Including another URLconf
    1. Import the include() function: from django.conf.urls import url, include
    2. Add a URL to urlpatterns:  url(r'^blog/', include('blog.urls'))
"""
from django.conf.urls import url
from django.contrib import admin
from app01 import  views
from app02 import  views as app02_views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^host/', app02_views.HostView.as_view()),
    url(r'^auth/', app02_views.AuthView.as_view()),
    # url(r'^users/', app02_views.users),
    # url(r'^user/(d+)', app02_views.user),
    url(r'^user/$', app02_views.UsersView.as_view()),  #as_view()方法里面执行了dispatch方法
    url(r'^user/(d+)', app02_views.UserView.as_view()),
]

from  rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import APIException
from app02 import models


class MyAuthentication(BaseAuthentication):
    def authenticate(self, request):
        token=request.query_params.get('token')
        print(token)
        obj=models.UserInfo.objects.filter(token=token).first()
        print(obj)
        if obj:
            return (obj.username,obj)
        raise  APIException('没有通过验证')

REST_FRAMEWORK={
    "UNAUTHENTICATED_USER":None,
    "UNAUTHENTICATED_TOKEN":None,
    "DEFAULT_AUTHENTICATION_CLASSES":["app02.utils.MyAuthentication",]
}

注：rest_framewor是一个app需要settings里面设置。