django 之swagger配置與生成接口文檔

swagger好處不多說，直接上配置步驟

1、安裝swagger

pip install django-rest-swagger

2、將swagger配置到setting.py文件中

3、在主url.py中配置接口文檔路徑

代碼解析：

from rest_framework.schemas import get_schema_view  # 導入restframework的輔助函數get_schema_view


from rest_framework_swagger.renderers import  # 導入swagger的兩個Render類SwaggerUIRenderer,OpenAPIRenderer

# 利用get_schema_view()方法，傳入兩個Render類得到一個schema view
schema_view = get_schema_view(title='API',renderer_classes=[SwaggerUIRenderer,OpenAPIRenderer])


urlpatterns = [

    path('docs/', schema_view, name="swagger接口文檔")  # 配置接口文檔的url
]

 

4、啟動服務，在瀏覽器中輸入 127.0.0.1:8000/docs訪問接口文檔

搞事情，運行后發現報錯了，沒有未認證

5、解決步驟4中權限問題，加入身份認證

schema_view = get_schema_view(title='API', renderer_classes=[SwaggerUIRenderer, OpenAPIRenderer], permission_classes=())

再次啟動服務，訪問接口地址