基于django-restframework的REST API

django-restframework模块是一个RET API开发工具，功能强大而且灵活。

需求

必要安装：

• Python (3.5, 3.6, 3.7, 3.8)
• Django (1.11, 2.0, 2.1, 2.2, 3.0)

可选安装：

coreapi (1.32.0+) - 模式生成支持
Markdown (3.0.0+) - Markdown 支持
Pygments (2.4.0+) - Markdown 语法高亮处理
django-filter (1.0.1+) 
django-guardian (1.1.1+) - Object level permissions support.

下面假设您已经配置好Python环境，并正确安装Django，关于Django的安装、创建项目、创建App等内容不在本文的描述范围。

安装

使用PIP安装，包括可选模块：

pip install djangorestframework
pip install markdown # Markdown support for the browsable API.
pip install django-filter # Filtering support

...从 github 安装.

git clone https://github.com/encode/django-rest-framework

添加 'rest_framework' Setting 文件的 INSTALLED_APPS 中.

INSTALLED_APPS = [
    ...
    'rest_framework',
]

如果你的希望在浏览器中验证你的API，并且需要身份验证，你可以在项目的根url.py文件中添加以下代码，这样可以在浏览界面增加用户登录功能。

urlpatterns = [
    ...
    url(r'^api-auth/', include('rest_framework.urls'))
]

URL '^api-auth/' 可任意修改。

举个例子

配置

所有关于REST framework API的配置参数都保存在名为REST_FRAMEWORK的配置字典中。 添加以下代码到 settings.py 模块中:

REST_FRAMEWORK = {
    # Use Django's standard `django.contrib.auth` permissions,
    # or allow read-only access for unauthenticated users.
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
    ]
}

这里指定了API访问的用户权限rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly， 表示已登录用户可写，匿名用户只读。

准备

以一个博客网站为例，使用REST框架构建简单的模型支持API。

假设一个Django的博客网站项目已经搭建完成，接下来要创建一组关于博客文章（模型Artile）的读写访问API。 Article模型的定义大体上如下面代码所示：

from django.db import models
from mdeditor.fields import MDTextField

class Article(models.Model):
    title = models.CharField(max_length=64, verbose_name='标题')
    content = MDTextField(verbose_name='内容')
    # ...

为使用命令python manage.y startapp api为Web Api创建一个独立的App。

配置路由

在api app下的 urls.py 文件中输入下面代码:

from django.urls import path, include
from rest_framework import routers
from api import views

route = routers.DefaultRouter()
route.register(r'article', views.BlogViewSet)

urlpatterns = [
    path('api/', include(route.urls))
]

使用route.register()方法即可生成一组路由，不需要为每一个模型的访问创建增删改查创建路由。

views.BlogViewSet 是视图类，将在后面讲解如何实现。

记得把这个模块添加到根urls.py模块中。

视图实现

直接代码：

from blog.models import Article
from api.serializes import ArticleSerializers
from rest_framework import viewsets

class BlogViewSet(viewsets.ModelViewSet):
    queryset = Article.objects.filter(is_article=True, is_category=False)
    serializer_class = ArticleSerializers

一个简单的实现，从ModelViewSet派生一个类型，并指定queryset 和 serializer_class， 后者是一个描述如何序列化模型的类型。

更复杂的实现可以包含权限、分页等内容。

序列化实现

实现Article序列化

from blog.models import Article
from rest_framework import serializers

# Serializers define the API representation.
class ArticleSerializers(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Article
        fields = ['pk', 'title', 'content']

最后，在本地启动服务，在浏览器中访问 http://127.0.0.1:8000/api/article 就可以浏览‘article’ api。使用已有帐号登录网站，可以尝试创建、修改、删除操作。