正文

Django REST框架：新手入门实战笔记，轻松掌握Web API开发

/0 浏览量
0402

引言

作为一名年轻的探索者，你也许对构建Web API充满好奇。Django REST框架，作为Python中最受欢迎的Web API开发工具之一，可以帮助你轻松实现这一目标。本文将带你从零开始，深入了解Django REST框架，并通过实战案例，让你轻松掌握Web API开发。

一、Django REST框架简介

1.1 什么是Django REST框架

Django REST框架（简称DRF）是一个基于Django的强大工具，用于构建Web API。它提供了大量功能，包括模型序列化、视图集、路由器、认证和权限等。

1.2 Django REST框架的优势

  • 易于使用：基于Django，可以快速上手。
  • 功能丰富：支持JSON、XML等多种数据格式，支持多种认证和权限方式。
  • 高度可定制：可根据需求进行扩展和定制。

二、Django REST框架快速入门

2.1 环境搭建

首先，确保你的电脑上已安装Django和Django REST框架。以下是安装命令：

pip install django djangorestframework

2.2 创建Django项目

创建一个新的Django项目，如下所示：

django-admin startproject myproject

2.3 创建应用

在项目目录下，创建一个应用：

cd myproject
python manage.py startapp myapp

2.4 添加应用

在myproject/settings.py文件中，将myapp添加到INSTALLED_APPS列表中。

2.5 定义模型

在myapp/models.py文件中，定义一个模型，如下所示：

from django.db import models

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

2.6 创建序列化器

在myapp/serializers.py文件中，创建一个序列化器：

from rest_framework import serializers
from .models import MyModel

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

2.7 创建视图

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

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

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

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

2.8 创建路由

在myapp/urls.py文件中，创建路由：

from django.urls import path
from .views import MyModelListCreate, MyModelDetailUpdateDestroy

urlpatterns = [
    path('mymodels/', MyModelListCreate.as_view()),
    path('mymodels/<int:pk>/', MyModelDetailUpdateDestroy.as_view()),
]

在myproject/urls.py文件中，将myapp的路由添加到项目路由中：

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('myapp.urls')),
]

2.9 运行服务器

在项目根目录下，运行以下命令启动服务器：

python manage.py runserver

打开浏览器，访问http://127.0.0.1:8000/api/mymodels/，即可看到API接口。

三、实战案例：创建一个简单的博客系统

3.1 创建模型

在myapp/models.py文件中，定义博客模型：

from django.db import models

class Blog(models.Model):
    title = models.CharField(max_length=100)
    content = models.TextField()
    author = models.CharField(max_length=100)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

3.2 创建序列化器

在myapp/serializers.py文件中，创建博客序列化器：

from rest_framework import serializers
from .models import Blog

class BlogSerializer(serializers.ModelSerializer):
    class Meta:
        model = Blog
        fields = '__all__'

3.3 创建视图

在myapp/views.py文件中，创建博客视图：

from rest_framework import generics
from .models import Blog
from .serializers import BlogSerializer

class BlogListCreate(generics.ListCreateAPIView):
    queryset = Blog.objects.all()
    serializer_class = BlogSerializer

class BlogDetailUpdateDestroy(generics.RetrieveUpdateDestroyAPIView):
    queryset = Blog.objects.all()
    serializer_class = BlogSerializer

3.4 创建路由

在myapp/urls.py文件中，创建博客路由：

from django.urls import path
from .views import BlogListCreate, BlogDetailUpdateDestroy

urlpatterns = [
    path('blogs/', BlogListCreate.as_view()),
    path('blogs/<int:pk>/', BlogDetailUpdateDestroy.as_view()),
]

3.5 运行服务器

启动服务器，访问http://127.0.0.1:8000/api/blogs/，即可看到博客系统的API接口。

四、总结

通过本文的学习，相信你已经对Django REST框架有了初步的了解，并且能够通过实战案例创建一个简单的博客系统。Django REST框架是一个非常强大的工具，可以帮助你轻松实现Web API开发。继续深入学习，你将能够发挥其强大的功能，构建更加复杂的Web API项目。祝你在Web API开发的道路上越走越远！

-- 展开阅读全文 --