swagger editor使用
swagger是一套開源的API設計工具,包括Swagger UI,Swagger Editor等。
Swagger Editor
其中Swagger Editor是個用Angular開發的WEB小程序,它可以讓你用YAML來定義你的接口規范,並實時驗證和現實成接口文檔。
此外,它還可以通過接口文檔幫你生成不同框架的服務端和客戶端,方便你mock和契約測試。最后導出JSON格式的API規范,通過Swagger UI對外發布。
生成PDF接口文檔
現在書寫和發布API文檔變得快速和輕松,但是有時候,對端希望能有一個離線的WORD或者PDF文檔。但當前版本的Swagger Editor並沒有導出文檔的功能。
轉了轉github,倒是發現了幾個開源項目,可以轉換為PDF,但是感覺都比較繁瑣。
突然想到瀏覽器可以打印成PDF格式,試驗了一下,確實可以。不過接口很多內容都折疊起來了,看不到明細,起不到文檔的作用。
不如寫句JS,在控制台上運行一下,遍歷下所有折疊的節點,然后單擊打開。
var node = document.getElementsByClassName('toggle-handle');
for(var i= 0;i< node.length ; i++){ angular.element(node[i]).click();}
這下可以很方便的生成PDF文檔了。