swagger editor使用

二胡嘈子發表於2016-03-17

swagger editor使用

swagger是一套開源的API設計工具,包括Swagger UI,Swagger Editor等。

Swagger Editor

其中Swagger Editor是個用Angular開發的WEB小程式,它可以讓你用YAML來定義你的介面規範,並實時驗證和現實成介面文件。
swagger editor使用

此外,它還可以通過介面文件幫你生成不同框架的服務端和客戶端,方便你mock和契約測試。最後匯出JSON格式的API規範,通過Swagger UI對外發布。
swagger editor使用
swagger editor使用

生成PDF介面文件

現在書寫和釋出API文件變得快速和輕鬆,但是有時候,對端希望能有一個離線的WORD或者PDF文件。但當前版本的Swagger Editor並沒有匯出文件的功能。

轉了轉github,倒是發現了幾個開源專案,可以轉換為PDF,但是感覺都比較繁瑣。

突然想到瀏覽器可以列印成PDF格式,試驗了一下,確實可以。不過介面很多內容都摺疊起來了,看不到明細,起不到文件的作用。

swagger editor使用

不如寫句JS,在控制檯上執行一下,遍歷下所有摺疊的節點,然後單擊開啟。

var node = document.getElementsByClassName('toggle-handle');
for(var i= 0;i< node.length ; i++){  angular.element(node[i]).click();}

swagger editor使用

這下可以很方便的生成PDF文件了。

相關文章