使用REST-Framework做Django后端接口

最新推荐文章于 2024-06-29 09:21:28 发布

菜鸡成长之路

最新推荐文章于 2024-06-29 09:21:28 发布

阅读量353

点赞数

分类专栏：学习笔记文章标签： Django Restful Api

本文链接：https://blog.csdn.net/sinat_40477296/article/details/100620636

版权

学习笔记专栏收录该内容

33 篇文章 2 订阅

订阅专栏

本文介绍了如何利用Django的REST-Framework构建后端API接口，包括创建虚拟环境、安装依赖、定义Model、编写序列化类、设计 Views 和处理CSRF保护。讲解了在Django中开启和禁用CSRF保护的方法，并提到了在模板中使用CSRF token的细节。

摘要由CSDN通过智能技术生成

创建虚拟环境

python3 -m venv env
source env/bin/activate

下载依赖

pip install django
pip install djangorestframework
pip install pyments

开始

创建app

python manage.py startapp snippets

添加app到settings.py

INSTALLED_APPS=[
    'rest_framework',
    'snippets',
]

创建Model

from django.db import models
from pygments.lexers import get_all_lexers
from pygments.styles import get_all_styles

LEXERS = [item for item in get_all_lexers() if item[1]]
LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
STYLE_CHOICES = sorted([(item, item) for item in get_all_styles()])


class Snippet(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100, blank=True, default='')
    code = models.TextField()
    linenos = models.BooleanField(default=False)
    language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
    style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)

    class Meta:
        ordering = ['created']

整合model

python manage.py makemigrations snippets
python manage.py migrate

创建一个序列化类

class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model=Snippet
        fields=['id','title','code','linenos','language','style']

创建Views

@csrf_exempt
def snippet_list(request):
    if request.method=='GET':
        snippets=Snippet.objects.all()
        serializer=SnippetSerializer(snippets,many=True)
        return JsonResponse(serializer.data,safe=False)
    elif request.method=='POST':
        data=JSONParser().parse(request)
        serializer=SnippetSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data,status=201)
        return JsonResponse(serializer.errors,status=400)
    
    
@csrf_exempt
def snippet_detail(request, pk):
    """
    Retrieve, update or delete a code snippet.
    """
    try:
        snippet = Snippet.objects.get(pk=pk)
    except Snippet.DoesNotExist:
        return HttpResponse(status=404)

    if request.method == 'GET':
        serializer = SnippetSerializer(snippet)
        return JsonResponse(serializer.data)

    elif request.method == 'PUT':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(snippet, data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data)
        return JsonResponse(serializer.errors, status=400)

    elif request.method == 'DELETE':
        snippet.delete()
        return HttpResponse(status=204)

解释一下：

django为了用户实现防止跨站请求伪造的功能，通过中间件django.middleware.csrf.CsrfViewMiddleware来完成

局部

@csrf_protect 为当前函数强制设置防跨站请求伪造功能，即便settings中没有设置全局中间件

@csrf_exempt 取消当前函数的防跨站请求功能

我们在form表单的时候会添加{%csrf_token%}会生成csrf的随机字符

设置urls.py

urlpatterns=[
    path('snippets/',views.snippet_list),
    path('snippets/<int:pk>/',views.snippet_detail)
]

urlpatterns=[
    path('',include('snippets.urls'))
]