如何在Django中打开swagger文档
时间: 2024-06-08 22:07:42 浏览: 168
在 Django 中打开 Swagger 文档需要安装 `django-rest-swagger` 库,可以通过以下命令进行安装:
```
pip install django-rest-swagger
```
安装完成后,在你的 Django 项目中的 `settings.py` 文件中添加以下配置:
```python
INSTALLED_APPS = [
# 其他应用
'rest_framework',
'rest_framework.authtoken',
'django_filters',
'drf_yasg',
]
SWAGGER_SETTINGS = {
'USE_SESSION_AUTH': False, # 禁用 session 认证
'SECURITY_DEFINITIONS': {
'api_key': {
'type': 'apiKey',
'name': 'Authorization',
'in': 'header'
},
},
}
# 视图路由中添加
from rest_framework.documentation import include_docs_urls
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
schema_view = get_schema_view(
openapi.Info(
title='API文档',
default_version='v1',
description='API接口文档',
terms_of_service='https://www.google.com/policies/terms/',
contact=openapi.Contact(email='contact@snippets.local'),
license=openapi.License(name='BSD License'),
),
public=True,
permission_classes=[permissions.AllowAny, ],
)
urlpatterns = [
# 其他路由
url(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
url(r'^docs/$', include_docs_urls(title='API文档', authentication_classes=[], permission_classes=[])),
]
```
添加完以上配置后,访问 `http://localhost:8000/swagger/` 即可打开 Swagger 文档页面。
阅读全文