Swagger簡單介紹


一句話介紹 Swagger

Swagger是一個接口文檔生成工具,同時提供接口測試調用的輔助功能。

 

關於 Swagger

Swagger能成為最受歡迎的REST APIs文檔生成工具之一,有以下幾個原因:

  • mSwagger 可以生成一個具有互動性的API控制台,開發者可以用來快速學習和嘗試API。
  • Swagger 可以生成客戶端SDK代碼用於各種不同的平台上的實現。
  • Swagger 文件可以在許多不同的平台上從代碼注釋中自動生成。
  • Swagger 有一個強大的社區,里面有許多強悍的貢獻者。
  • Swagger 文檔提供了一個方法,使我們可以用指定的 JSON 或者 YAML 摘要來描述你的 API,包括了比如 names、order 等 API 信息。

你可以通過一個文本編輯器來編輯 Swagger 文件,或者你也可以從你的代碼注釋中自動生成。各種工具都可以使用 Swagger 文件來生成互動的 API 文檔。

注意:用 Swagger 文件生成互動的 API 文檔是最精簡的,它展示了資源、參數、請求、響應。但是它不會提供你的API如何工作的其他任何一個細節。

Swagger 組件

Swagger 分成一些不同的塊。

    • Swagger spec:這一塊對元素的嵌套、命令等采用官方模式。如果你想要對 Swagger 文件手動編碼,你必須非常熟悉 Swagger spec。

    • Swagger editor:這是在線編輯器,用於驗證你的 YML 格式的內容是否違反 Swagger spec 。YML 是一種句法,依賴於空格和嵌套。你需要對 YML 句法很熟悉才能很好的遵守 Swagger spec 規范。Swagger 編輯器會標出錯誤並且給你格式提醒(Swagger spec 文件可以使用 JSON 或者 YAML 中的任意一種格式)

       

    • Swagger-UI:這是一套 HTML/CSS/JS 框架用於解析遵守 Swagger spec 的 JSON 或 YML 文件,並且生成API文檔的UI導航。它可以將你的規格文檔轉換成Swagger Petsotre-like UI。

    • Swagger-codegen:這個工具可以為不同的平台生成客戶端 SDK(比如 Java、JavaScript、Python 等)。這些客戶端代碼幫助開發者在一個規范平台中整合 API ,並且提供了更多健壯的實現,可能包含了多尺度、線程,和其他重要的代碼。SDK 是用於支持開發者使用 REST API 的工具。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM