使用 Django 和 Django REST Framework (DRF) 构建简单 API 的示例

LXSHYZHX2024-06-03 19:44

以下是一个使用 Django 和 Django REST Framework (DRF) 构建简单 API 的示例。这个示例展示了如何创建一个简单的书籍管理系统，包括创建、读取、更新和删除书籍信息。

创建 Django 项目和应用
首先，创建一个新的 Django 项目和应用：

bash 复制代码

django-admin startproject myproject
cd myproject
django-admin startapp books

安装 Django REST Framework
在你的 Django 项目中安装 Django REST Framework：

bash 复制代码

pip install djangorestframework

配置 settings.py
在 myproject/settings.py 中添加 rest_framework 到 INSTALLED_APPS：

python 复制代码

INSTALLED_APPS = [
    ...
    'rest_framework',
    'books',
]

创建模型 (models.py)
在 books/models.py 中定义一个简单的书籍模型：

python 复制代码

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)
    published_date = models.DateField()

    def __str__(self):
        return self.title

创建序列化器 (serializers.py)
在 books/serializers.py 中创建一个序列化器：

python 复制代码

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

创建视图 (views.py)
在 books/views.py 中创建视图：

python 复制代码

from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

配置 URL (urls.py)
在 myproject/urls.py 中配置 URL 路由：

python 复制代码

from django.contrib import admin
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from books.views import BookViewSet

router = DefaultRouter()
router.register(r'books', BookViewSet)

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

迁移数据库
运行数据库迁移命令以创建 Book 模型的数据库表：

bash 复制代码

python manage.py makemigrations
python manage.py migrate

创建超级用户
创建一个超级用户以访问 Django 管理后台：

bash 复制代码

python manage.py createsuperuser

运行开发服务器
启动开发服务器：

bash 复制代码

python manage.py runserver

现在，你可以通过访问 http://127.0.0.1:8000/api/books/ 来查看和管理书籍信息。你也可以通过 Django 管理后台 http://127.0.0.1:8000/admin/ 来管理书籍数据。

这个示例展示了如何使用 Django 和 Django REST Framework 创建一个简单的 API，包括创建、读取、更新和删除书籍信息。