Python Django基础流程

创建一个Django项目

  1. 创建一个Python虚拟环境
python -m venv .venv
  1. 安装 Django
    确保你已经安装了 Python 和 pip,然后使用以下命令安装 Django:
pip install django
  1. 创建项目
    使用 django-admin 命令创建一个新的 Django 项目:
django-admin startproject [project_name]

这里的 project_name 是你的项目名称。

  1. 进入项目目录
    切换到新创建的项目目录中:
cd project_name
  1. 运行开发服务器
    启动 Django 开发服务器以确保项目创建成功:
python manage.py runserver 0.0.0.0:8000

打开浏览器访问 http://127.0.0.1:8000/ ,如果看到 Django 的欢迎页面,则表示项目创建成功。

  1. 创建应用(可选)
    Django 项目通常由多个应用组成。你可以使用以下命令创建一个应用:
python manage.py startapp app_name

这里的 app_name 是你的应用名称。

  1. 配置数据库和其他设置(可选)
    根据需要修改 settings.py 文件中的数据库、时区等配置信息。

创建一个接口

在 Django 中创建一个接口(API)可以使用原生的视图函数或类,也可以借助更强大的框架如 Django REST framework。以下是两种常见方式:


1. 使用 Django 原生视图创建简单接口

步骤如下:

  • 编写视图函数
    在应用的 views.py 文件中定义一个视图:

    from django.http import JsonResponse
    
    def example_api(request):
        data = {"message": "Hello, this is an API response!"}
        return JsonResponse(data)
    
  • 配置 URL 路由
    在应用目录下创建或修改 urls.py 文件:

    from django.urls import path
    from . import views
    
    urlpatterns = [
        path('example/', views.example_api, name='example_api'),
    ]
    

    然后在项目的主 urls.py 中包含该应用的路由:

    from django.urls import include, path
    
    urlpatterns = [
        # 其他路径...
        path('api/', include('your_app_name.urls')),
    ]
    
  • 访问接口
    启动服务器后,访问 http://127.0.0.1:8000/api/example/ 就可以看到 JSON 格式的响应。


2. 使用 Django REST Framework (DRF)

安装 DRF:

pip install djangorestframework

settings.pyINSTALLED_APPS 中添加:

'rest_framework',
'your_app_name',

创建 API 示例:

  • 定义序列化器(Serializer)

    from rest_framework import serializers
    
    class ExampleSerializer(serializers.Serializer):
        message = serializers.CharField()
    
  • 编写基于 DRF 的视图

    from rest_framework.views import APIView
    from rest_framework.response import Response
    from rest_framework import status
    
    class ExampleApiView(APIView):
        def get(self, request):
            data = {"message": "Hello from DRF API!"}
            return Response(data, status=status.HTTP_200_OK)
    
  • 配置 URL 路由

    from django.urls import path
    from your_app_name.views import ExampleApiView
    
    urlpatterns = [
        path('drf-example/', ExampleApiView.as_view(), name='drf_example'),
    ]
    
  • 访问接口
    启动服务后访问 http://127.0.0.1:8000/api/drf-example/,你会看到一个美观的 DRF 风格页面展示 JSON 数据。


总结

方式特点推荐场景
Django 原生视图简单、轻量快速实现小型 API 或调试用
Django REST Framework功能丰富、支持认证、分页等构建正式、可扩展的 RESTful API

如果你需要构建功能完整的接口系统,建议使用 Django REST Framework