Django的restful用法（自带的增删改查）_django restful

什么是rest

REST是所有Web应用都应该遵守的架构设计指导原则。

Representational State Transfer，翻译是”表现层状态转化”。

面向资源是REST最明显的特征，对于同一个资源的一组不同的操作。资源是服务器上一个可命名的抽象概念，资源是以名词为核心来组织的，首先关注的是名词。

REST要求，必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT(PATCH)用来更新资源，DELETE用来删除资源。

api定义规范

http://xxx.com/api/
1

资源

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的”集合”（collection），所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

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

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

https://api.example.com/v1/employees
1
2
3
4
5

http请求方式

GET（SELECT）：从服务器取出资源（一项或多项）

POST（CREATE）：在服务器新建一个资源

PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）

PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）

DELETE（DELETE）：从服务器删除资源
1
2
3
4
5
6
7
8
9

filter过滤

?page=2&per_page=100：指定第几页，以及每页的记录数。

?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。

?animal_type_id=1：指定筛选条件
1
2
3
4
5

状态码

服务端向用户返回请求api的结果，在结果中包含了status codes 状态码的，可以通过状态码去判断请求api的状态是成功还是失败

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

具体用法

更多的需要配合postman 因此需要下载一个postman，方便更多的操作

https://www.getpostman.com/apps

使用之前安装模块

pip install djangorestframework
pip install django-filter

在setting.py中加入参数

INSTALLED_APPS中加入’rest_framework’，

在app中创建一个py文件——序列化文件

比如serializers.py然后写入restful

from rest_framework import serializers
from stu.models import Student（导入自己写的app、models）


class StudentSerializer(serializers.ModelSerializer):

    class Meta:
        # 关联数据表（前面不是变量名）
        model = Student
        # 确定需要序列化的字段（返回给用户的具体表中的字段）（前面不是变量名）
        fields = ['id', 's_name', 's_tel']

    def to_representation(self, instance):

        data = super().to_representation(instance)

        try:
            # 得到关联表中的字段，必须用try,否则如果存在一个没有定义i_addr的学生时，系统将报错
            data['s_addr'] = instance.studentinfo.i_addr
        except Exception as e:
            data['s_addr'] = ''

        return data
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

在app中views中创建类

from rest_framework import mixins,viewsets
from stu.serializers import StudentSerializer
from stu.models import Student


class StudentEdit(mixins.ListModelMixin,# 表示可以在Postman类似的软件中只能查找所有数据
                  viewsets.GenericViewSet,
                  mixins.RetrieveModelMixin,  # 表示可以在Postman类似的软件中只能查找单一数据
                  mixins.UpdateModelMixin,    # 表示可以在Postman类似的软件中更新数据
                  mixins.DestroyModelMixin,   # 表示可以在Postman类似的软件中删除数据
                  mixins.CreateModelMixin):   # 表示可以在Postman类似的软件中创建数据

    # 查询所有信息
    queryset = Student.objects.all()
    # 序列化
    serializer_class = StudentSerializer
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

创建urls

这里同时展示了urls不一定每次都写入进去可以用+=添加进去
注意这里写的urls不要加‘/’他会自动加载

from stu import views
from rest_framework.routers import SimpleRouter

router = SimpleRouter()
router.register(r'student', views.StudentEdit)

urlpatterns = [
    # 其他url
]

urlpatterns += router.urls #这里表示添加定义的url
1
2
3
4
5
6
7
8
9
10
11

对应的方法

在postman中选入某个参数然后传入某个urls即可

增： POST http://127.0.0.1:8080/stu/addStu/1/

删： DELETE http://127.0.0.1:8080/stu/addStu/1/

改： UPDATE http://127.0.0.1:8080/stu/addStu/1/

查： GET http://127.0.0.1:8080/stu/addStu/1
1
2
3
4
5
6
7

能执行这些操作前都需要在views中定义好才行