Django REST FRAMEWORK swagger（一）框架詳解

Django REST FRAMEWORK swagger（一、框架詳解）

一.Django REST  SWAGGER框架圖

具體見下圖

二.說明

• RESTFul說明

1. 每一個URI代表一種資源；

2. 客戶端和服務器之間，傳遞這種資源的某種表現層；

3. 客戶端通過四個HTTP動詞，對服務器端資源進行操作，實現"表現層狀態轉化"。

• Swagger說明

1. 大部分 Web 應用程序都支持 RESTful API，但不同於 SOAP API——REST API 依賴於 HTTP 方法，缺少與 Web 服務描述語言（Web Services Description Language，WSDL）類似的語言來定義使用者與提供者之間的請求和響應結構。由於沒有充分的合同服務，許多 REST API 提供者使用 Microsoft Word 文檔或維基頁面來記錄 API 用法。這些格式使協作和文檔版本控制變得很困難，尤其對於有許多 API 或資源的應用程序，或者在 API 采用迭代式開發方式時。這些文檔類型在集成到自動化測試應用程序中時變得更難。

2. 開源 Swagger 框架幫助 API 使用者和開發人員糾正了這些問題。該框架為創建 JSON 或 YAML（JSON 的一個人性化的超集）格式的 RESTful API 文檔提供了 OpenAPI 規范（以前稱為 Swagger 規范）。Swagger 文檔可由各種編程語言處理，可在軟件開發周期中簽入源代碼控制系統中，以便進行版本管理。

3. 實現 Swagger 擴展。

4. 簡化 Swagger 的功能來聚合文檔。

5. 創建一個輸出 Swagger 文檔為 HTML 頁面的工具。