Django中自定义实现RESTful API

什么是restful api

　　可以总结为一句话：REST是所有Web应用都应该遵守的架构设计指导原则。 Representational State Transfer，翻译是”表现层状态转化”。 面向资源是REST最明显的特征，对于同一个资源的一组不同的操作。REST要求，必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。（7个HTTP方法：GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS）

Restful API设计规范

1，资源。首先是弄清楚资源的概念。资源就是网络上的一个实体，一段文本，一张图片或者一首歌曲。资源总是要通过一种载体来反应它的内容。JSON是现在最常用的资源表现形式。

2，统一接口。RESTful风格的数据元操CRUD（create,read,update,delete）分别对应HTTP方法：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源，这样就统一了数据操作的接口。

3，URI。可以用一个URI（统一资源定位符）指向资源，即每个URI都对应一个特定的资源。要获取这个资源访问它的URI就可以，因此URI就成了每一个资源的地址或识别符。一般的，每个资源至少有一个URI与之对应，最典型的URI就是URL。

4，无状态。所谓无状态即所有的资源都可以URI定位，而且这个定位与其他资源无关，也不会因为其他资源的变化而变化。有状态和无状态的区别，举个例子说明一下，

　　例如要查询员工工资的步骤为第一步：登录系统。第二步：进入查询工资的页面。第三步：搜索该员工。第四步：点击姓名查看工资。这样的操作流程就是有状态的，查询工资的每一个步骤都依赖于前一个步骤，只要前置操作不成功，后续操作就无法执行。如果输入一个URL就可以得到指定员工的工资，则这种情况就是无状态的，因为获取工资不依赖于其他资源或状态，且这种情况下，员工工资是一个资源，由一个URL与之对应可以通过HTTP中的GET方法得到资源，这就是典型的RESTful风格。

RESTful API其他一些规范

1：应该将API的版本号放入URL。GET:http://www.xxx.com/v1/friend/123。或者将版本号放在HTTP头信息中。

2：URL中只能有名词而不能有动词，URL只标识资源的地址，既然是资源那就是名词了。

3：如果记录数量很多，API应该提供参数，过滤返回结果。?limit=10：指定返回记录的数量、?page=2&per_page=100：指定第几页，以及每页的记录数。

　　PS：我介绍的是自定义实现Django restful，当然Django中有一种更快捷、强大的方法，那就是 Django REST framework。它是python的一个模块，通过在Django里面的配置就可以把app的models中的各个表实现RESTful API。


RESTful API的简单实现

目录结构

 

具体代码

准备：先在models中建一个Person类插入一些数据。

api_v1.py:

from django.forms import model_to_dict
from django.http import QueryDict, JsonResponse
from django.views.generic import View
from app.models import *


class PersonAPI(View):
    def get(self,req):
        data = Person.objects.all()
        person = [model_to_dict(i) for i in data]
        result = {
            'code':1,
            'msg':'数据查询到了',
            'data':person
        }
        return JsonResponse(result)

    def post(self,req):
        name = req.POST.get('name')
        age = req.POST.get('age')
        res = Person.objects.create(name = name,age = age)
        result = {
            'code':1,
            'msg':'数据创建成功',
            'data':model_to_dict(res)
        }
        return JsonResponse(result)

    def delete(self,req):
        params = QueryDict(req.body)
        id = int(params.get('s_id'))
        res = Person.objects.get(pk=id)
        res.delete()
        result = {
            'code':1,
            'msg':'数据删除成功',
            'data':id
        }
        return JsonResponse(result)

　　当请求的方法不同时，会自动根据请求的方法分发到不同的函数方法来执行相应的操作。我这里只写了三种方法，要是是这三种以外的方法访问的话，会报405错误，说请求方法不被允许。

urls_api_v1.py:

from django.conf.urls import url
from app.api_v1 import *

urlpatterns = [
    url('^personapi$',PersonAPI.as_view()),
]

urls.py:

from django.conf.urls import url,include
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^api/v1/', include('app.urls_api_v1')),
]