当前位置：首页 > news >正文

Django 和 Django REST framework 创建对外 API

news 2025/7/19 18:13:51

1. 环境准备

确保你已经安装了 Python 和 Django。如果尚未安装 Django REST framework，通过 pip 安装它：

pip install djangorestframework

2. 创建 Django 项目

如果你还没有 Django 项目，可以通过以下命令创建：

django-admin startproject myproject cd myproject

3. 创建应用

在项目中创建一个新的 Django 应用：

python manage.py startapp myapp

4. 添加应用到项目

将新创建的应用和 rest_framework 添加到 INSTALLED_APPS 配置中：

# myproject/settings.py INSTALLED_APPS = [ # ... 'rest_framework', 'myapp', ]

5. 数据库模型

在 myapp/models.py 中定义你的数据模型。这些模型将映射到数据库表：

from django.db import models

class MyModel(models.Model):

name = models.CharField(max_length=100)

description = models.TextField()

运行迁移来创建数据库表：

python manage.py makemigrations

python manage.py migrate

6. 创建 Serializers

在 myapp/serializers.py 中创建序列化器来转换模型实例和反序列化传入的数据：

from rest_framework import serializers from .models import MyModel

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

7. 创建 Views

在 myapp/views.py 中创建视图来处理 API 请求。你可以使用 Django REST framework 的视图集或 APIView：

from rest_framework import viewsets
from .models import MyModel
from .serializers import MyModelSerializerclass MyModelViewSet(viewsets.ModelViewSet):queryset = MyModel.objects.all()serializer_class = MyModelSerializer

8. 配置 URL 路由

在 myapp/urls.py 中配置 URL 路由以指向你的视图：

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import MyModelViewSetrouter = DefaultRouter()
router.register(r'mymodels', MyModelViewSet)urlpatterns = [path('', include(router.urls)),
]

确保在项目的主 urls.py 文件中包含应用的 URL 配置：

# myproject/urls.pyfrom django.contrib import admin
from django.urls import path, includeurlpatterns = [path('admin/', admin.site.urls),path('api/', include('myapp.urls')),  # 包含 myapp 的 URL 配置
]