Django REST Swagger 项目教程
1. 项目的目录结构及介绍
Django REST Swagger 项目的目录结构如下:
django-rest-swagger/
├── django_rest_swagger/
│ ├── __init__.py
│ ├── renderers.py
│ ├── settings.py
│ ├── urls.py
│ ├── views.py
│ └── ...
├── example/
│ ├── manage.py
│ ├── example/
│ │ ├── __init__.py
│ │ ├── settings.py
│ │ ├── urls.py
│ │ ├── wsgi.py
│ │ └── ...
│ └── ...
├── runtests.py
├── setup.py
├── README.md
└── ...
目录结构介绍
django_rest_swagger/
: 包含 Django REST Swagger 的核心代码。__init__.py
: 初始化文件。renderers.py
: 渲染器相关代码。settings.py
: 配置相关代码。urls.py
: URL 配置。views.py
: 视图相关代码。
example/
: 示例项目目录。manage.py
: Django 管理脚本。example/
: 示例项目的配置和应用代码。__init__.py
: 初始化文件。settings.py
: 示例项目的配置文件。urls.py
: 示例项目的 URL 配置。wsgi.py
: WSGI 应用入口。
runtests.py
: 测试脚本。setup.py
: 安装脚本。README.md
: 项目说明文档。
2. 项目的启动文件介绍
manage.py
manage.py
是 Django 项目的管理脚本,用于启动开发服务器、运行测试、创建数据库迁移等操作。使用方法如下:
python manage.py runserver
wsgi.py
wsgi.py
是 WSGI 应用的入口文件,用于在生产环境中部署 Django 应用。通常由 Web 服务器(如 Apache 或 Nginx)调用。
3. 项目的配置文件介绍
settings.py
settings.py
是 Django 项目的配置文件,包含数据库配置、应用安装、中间件、静态文件路径等设置。以下是一些关键配置项:
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework_swagger', # 添加 Django REST Swagger 应用
]
REST_FRAMEWORK = {
'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}
SWAGGER_SETTINGS = {
'SECURITY_DEFINITIONS': {
'basic': {
'type': 'basic'
}
},
}
urls.py
urls.py
是 Django 项目的 URL 配置文件,用于定义 URL 与视图之间的映射关系。以下是示例配置:
from django.conf.urls import url
from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='API 文档')
urlpatterns = [
url(r'^$', schema_view),
]
通过以上配置,可以生成 Swagger UI 文档页面。