曾經用過這個工具枚驻,用起來非常方便,不用寫接口文檔株旷,請求地址再登,字段都是代碼注解尔邓,然后自動生成,它是一個接口文檔生成工具锉矢,同時提供接口測試調用的輔助功能梯嗽。
Swagger能成為最受歡迎的REST APIs文檔生成工具之一,有以下幾個原因:
mSwagger 可以生成一個具有互動性的API控制臺沽损,開發(fā)者可以用來快速學習和嘗試API灯节。
Swagger 可以生成客戶端SDK代碼用于各種不同的平臺上的實現。
Swagger 文件可以在許多不同的平臺上從代碼注釋中自動生成绵估。
Swagger 有一個強大的社區(qū)炎疆,里面有許多強悍的貢獻者。
Swagger 文檔提供了一個方法国裳,使我們可以用指定的 JSON 或者 YAML 摘要來描述你的 API形入,包括了比如 names、order 等 API 信息缝左。
你可以通過一個文本編輯器來編輯 Swagger 文件亿遂,或者你也可以從你的代碼注釋中自動生成。各種工具都可以使用 Swagger 文件來生成互動的 API 文檔渺杉。
Swagger spec:這一塊對元素的嵌套蛇数、命令等采用官方模式。如果你想要對 Swagger 文件手動編碼是越,你必須非常熟悉 Swagger spec苞慢。
Swagger editor:這是在線編輯器,用于驗證你的 YML 格式的內容是否違反 Swagger spec 英妓。YML 是一種句法,依賴于空格和嵌套绍赛。你需要對 YML 句法很熟悉才能很好的遵守 Swagger spec 規(guī)范蔓纠。Swagger 編輯器會標出錯誤并且給你格式提醒(Swagger spec 文件可以使用 JSON 或者 YAML 中的任意一種格式)。
Swagger-UI:這是一套 HTML/CSS/JS 框架用于解析遵守 Swagger spec 的 JSON 或 YML 文件吗蚌,并且生成API文檔的UI導航腿倚。它可以將你的規(guī)格文檔轉換成Swagger Petsotre-like UI。
Swagger-codegen:這個工具可以為不同的平臺生成客戶端 SDK(比如 Java蚯妇、JavaScript敷燎、Python 等)。這些客戶端代碼幫助開發(fā)者在一個規(guī)范平臺中整合 API 箩言,并且提供了更多健壯的實現硬贯,可能包含了多尺度、線程陨收,和其他重要的代碼饭豹。SDK 是用于支持開發(fā)者使用 REST API 的工具鸵赖。