Django使用swagger生成接口文檔

參考博客：Django接入Swagger，生成Swagger接口文檔-操做解析

Swagger是一個規範和完整的框架，用於生成、描述、調用和可視化RESTful風格的Web服務。整體目標是使客戶端和文件系統源代碼做爲服務器以一樣的速度來更新。當接口有變更時，對應的接口文檔也會自動更新。

Swagger優點：

1. Swagger可生成一個具備互動性的API控制檯，開發者可快速學習和嘗試API；
2. Swagger可生成客戶端SDK代碼，用於不一樣平臺上（Java、Python...）的實現；
3. Swagger文件可在許多不一樣的平臺上從代碼註釋中自動生成；
4. Swagger有一個強大的社區，裏面有許多強悍的貢獻者。

---

django使用swagger主要步驟：

1. 安裝swagger；
2. 添加到swagger到配置文件；
3. 在主路由中配置路由；
4. 啓動服務，測試效果；

---

1、 安裝swagger

pip install django-rest-swagger

2、 將swagger添加到settings.py配置文件的INSTALLEDAPP中，如：

INSTALLED_APPS = [
	'django.contrib.admin',
	'django.contrib.auth',
	'django.contrib.contenttypes',
	'django.contrib.sessions',
	'django.contrib.messages',
	'django.contrib.staticfiles',
	'rest_framework',
	
	'rest_framework_swagger',  # swagger自動生成接口文檔
	]

3、 在主路由中配置接口文檔的路由： 在項目同名目錄下的urls.py中，填寫以下代碼：

from django.urls import path

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

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

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

# 配置接口文檔的訪問路徑
urlpatterns = [
    # 訪問localhost:8000/docs/便可
    path('docs/', schema_view, name="swagger接口文檔")
]

4、 在接口類視圖裏面寫上註釋，能夠被當成接口文檔說明顯示。啓動服務，訪問localhost:8000/docs/便可。

---

轉載請註明出處！