1. 程式人生 > 程式設計 >Django restful framework生成API文件過程詳解

Django restful framework生成API文件過程詳解

自動生成api文件(不管是函式檢視還是類檢視都能顯示)

1.安裝rest_framework_swagger庫

pip install django-rest-swagger

2.在專案下的 urls.py 中加入如下:

from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='API文件')
urlpatterns += [
  path(r'docs/',schema_view),]

3.在建立的django專案下的settings中加入如下:

INSTALLED_APPS = ['rest_framework_swagger']

REST_FRAMEWORK = {
  'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema'
}

4、生成的api文件介面如下:

Django restful framework生成API文件過程詳解

5、DRF訪問介面自帶的介面如下:

Django restful framework生成API文件過程詳解

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。