Django 和 Django REST framework 创建对外 API

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:

python 复制代码
from rest_framework import viewsets
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelViewSet(viewsets.ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer

8. 配置 URL 路由

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

python 复制代码
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import MyModelViewSet

router = DefaultRouter()
router.register(r'mymodels', MyModelViewSet)

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

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

复制代码
python 复制代码
# myproject/urls.py

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

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/', include('myapp.urls')),  # 包含 myapp 的 URL 配置
]

9. 权限和认证

根据需要配置 API 的权限和认证机制。Django REST framework 提供了多种认证类和权限类。

10. 测试 API

在本地开发环境中测试你的 API。你可以使用 Postman、curl 或 Django REST framework 的 browsable API 来测试。

11. 部署

将你的 Django 项目部署到服务器或云平台上。确保数据库、静态文件和媒体文件的配置正确。

12. 文档和版本控制

为你的 API 提供文档,可以使用 Django REST framework 的内置文档生成器或第三方工具如 Swagger。考虑 API 的版本控制策略,以便未来进行平滑升级。

13. 监控和日志

实施监控和日志记录机制,以便跟踪 API 的使用情况和性能问题。

14. 安全性

确保你的 API 安全,使用 HTTPS、输入验证、安全头部等措施来保护 API。

通过这些步骤,你可以创建一个对外提供的 Web API,允许客户端通过 HTTP 请求进行数据交互。记得在开发过程中遵循 RESTful 设计原则,确保 API 的可维护性和可扩展性。

相关推荐
TomEval9 小时前
【测AI】第26篇:线上模型监控与告警体系 — 测试不是终点
人工智能·python·功能测试·ai
prince_zxill10 小时前
PEP 751 pylock.toml 实测:pip 26.3 装 6 个包版本全钉死,但 [web] 选不中任何东西
python·pip·依赖管理·pep 751
Thanks_ks12 小时前
Python 的垃圾回收——引用计数撑起日常,分代回收收拾残局
python·内存管理·垃圾回收·循环引用·引用计数·gc 模块·weakref
CyrusYiVPP12 小时前
实测 uv 0.13.7:同一套包,pip 装 94 秒,它只用 19 秒
人工智能·python
yiangL_12 小时前
Python 学习笔记:递归、turtle绘图、字符串与函数
笔记·python·学习
程序员韩星12 小时前
OpenAI 兼容接口返回 404,先查请求地址,再查模型名
前端·人工智能·http
lula88813 小时前
PVC-U、PVC-C、PVC-O 差一个字母,差的是三种增强路线
python
数字工作台15 小时前
给 LangGraph 加一道可审计记忆:替换默认 Checkpointer,实现防篡改 + 崩溃不丢数据
python·agent
DKPT15 小时前
Python 的 Web 框架:选型选错的人,都踩了同一个坑
python
2401_8685347816 小时前
逻辑网络设计
网络·python