安裝
pip install django-rest-swagger
接入
在settings.py
的 INSTALLED_APPS
添加
'rest_framework_swagger',
在主 urls.py
文件中增加
from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title="Notes API")
urlpatterns = [
# path('admin/', admin.site.urls),
path("cmdb/", include("cmdb.urls")),
path('api/jwtauth/', include('user.urls'), name='jwtauth'),
path('api/docs/', schema_view), # 增加的內容
]
解決兼容性問題
rest_framework_swagger
目前只支持 django 2+
,django 3.2
版本是不支持的。
報錯內容:
django.template.exceptions.TemplateSyntaxError: 'staticfiles' is not a registered tag library. Must be one of:
解決辦法
找到我們安裝包的位置,一般都在 site-packages/rest_framework_swagger/templates/rest_framework_swagger
該目錄下有一個index.html
文件,把文件中第二行的{% load staticfiles %}
修改爲{% load static %}
。修改完重新刷新文檔頁面。