正文

新手必看：DRF框架轻松打造REST API，实战教程一网打尽

/0 浏览量
0720

在当今的Web开发领域，RESTful API因其简洁、高效和易于扩展的特点而备受青睐。Django REST framework（DRF）是一个强大的工具，可以帮助开发者快速构建RESTful API。如果你是新手，想要学习如何使用DRF来打造REST API，那么这篇文章将为你提供一网打尽的实战教程。

一、什么是DRF？

Django REST framework（DRF）是一个基于Django框架的库，用于构建Web API。它提供了丰富的功能，如序列化、视图集、路由器、权限和认证等。DRF使得构建RESTful API变得更加简单和高效。

二、安装DRF

首先，确保你的系统中已经安装了Django。然后，通过pip安装DRF：

pip install djangorestframework

三、创建Django项目和应用

  1. 创建一个新的Django项目：
django-admin startproject myproject
  1. 进入项目目录，创建一个新的应用：
cd myproject
python manage.py startapp myapp

四、配置DRF

  1. 在myproject/settings.py文件中，添加以下配置：
INSTALLED_APPS = [
    ...
    'rest_framework',
    'myapp',
]
  1. 设置DRF的版本：
REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ),
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.BasicAuthentication',
    ),
}

五、定义模型

在myapp/models.py中，定义一个模型：

from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=100)
    age = models.IntegerField()

六、序列化模型

在myapp/serializers.py中，定义一个序列化器：

from rest_framework import serializers
from .models import MyModel

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = '__all__'

七、创建视图

在myapp/views.py中，创建一个视图：

from rest_framework import generics
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelListCreateAPIView(generics.ListCreateAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

class MyModelRetrieveUpdateDestroyAPIView(generics.RetrieveUpdateDestroyAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

八、配置路由

在myproject/urls.py中，添加以下路由：

from django.urls import path
from myapp.views import MyModelListCreateAPIView, MyModelRetrieveUpdateDestroyAPIView

urlpatterns = [
    path('mymodels/', MyModelListCreateAPIView.as_view(), name='mymodels-list-create'),
    path('mymodels/<int:pk>/', MyModelRetrieveUpdateDestroyAPIView.as_view(), name='mymodels-retrieve-update-destroy'),
]

九、启动服务器

运行以下命令启动Django开发服务器：

python manage.py runserver

现在，你可以通过访问http://127.0.0.1:8000/mymodels/来测试你的API了。

十、总结

通过本文的实战教程，你学会了如何使用DRF来创建RESTful API。希望这篇文章能帮助你快速入门，并在实际项目中应用所学知识。祝你学习愉快！

-- 展开阅读全文 --