Django的夸张文档
django-swagger-render的Python项目详细描述
django swagger渲染
开始
先决条件
- python>;=3.5
- django>;=2.0
安装
使用pip安装
pip install django-swagger-render
在已安装的应用程序设置中添加“swagger\u render”。
INSTALLED_APPS = [
...
'swagger_render',
]
创建存储文档的文件夹
mkdir docs
使用一些OPENAPI
或Swagger
规范创建index.yml
文件
touch docs/index.yml
提供文档文件
urlpatterns += static('/docs/', document_root='docs')
将SWAGGER_YAML_FILENAME
设置添加到settings.py
SWAGGER_YAML_FILENAME = '/docs/index.yml'
将SwaggerUIView
添加到您的url中
from swagger_render.views import SwaggerUIView
urlpatterns = [
...
path('swagger/', SwaggerUIView.as_view()),
]
喂!