REST framework:介面文件

REST framework透過第三方庫可以自動幫助我們生成網頁版的介面文件，自動介面文件能生成的是繼承自APIView及其子類的檢視

1、安裝依賴

REST framewrok生成介面文件需要coreapi庫的支援

pip install coreapi -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host mirrors.aliyun.com

2、註冊應用

在專案settings註冊應用，配置如下

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    # 註冊應用
    'coreapi',
]

3、進行介面文件設定

在專案settings檔案，配置如下

REST_FRAMEWORK = {
    # 介面文件配置
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
   }

4、設定介面文件訪問路徑

在專案路由中新增介面文件的路由，配置如下

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    re_path(r'^docs/', include_docs_urls(title='介面文件'))

]

啟動Django專案，瀏覽器訪問 127.0.0.1:8000/docs/，即可看到自動生成的介面文件