? ? 在做項(xiàng)目時(shí)通常需要給客戶提供離線Word的API文檔歸檔,不要跟客戶說(shuō)有Swagger在線API文檔,客戶不會(huì)用也不會(huì)去看。只要你有Swagger,TableGo就能自動(dòng)生成一份漂亮的Word離線API文檔給客戶,大大提高了寫文檔的效率,客戶看了高興,大家項(xiàng)目交付的速度也快很多。支持Swagger2和Swagger3 OpenAPI3,使用TableGo的自定義模板功能還能生成Markdown格式的離線API文檔。
1、首先打開(kāi)Swagger找到api-docs的訪問(wèn)地址,這個(gè)地址提供了Swagger的文檔JSON數(shù)據(jù),離線文檔就是利用這些JSON數(shù)據(jù)來(lái)生成的


2、打開(kāi)TableGo,找到并打開(kāi)生成工具 → 生成自定義文件 → Swagger


3、將api-docs的訪問(wèn)地址填入“在線訪問(wèn)地址”,也可以把a(bǔ)pi-docs的JSON數(shù)據(jù)保存到本地JSON文件中,選擇離線JSON數(shù)據(jù)文件


? 配置文檔標(biāo)題,文檔標(biāo)題用于生成文件名和文檔標(biāo)題,title對(duì)應(yīng)“info.title”,description對(duì)應(yīng)“info.description”

? 如果只想生成指定模塊的API數(shù)據(jù),可以在模板設(shè)置中選擇需要的模塊

? 點(diǎn)擊“生成Word離線API文檔”按鈕即可生成文檔

4、打開(kāi)Document目錄,查看剛生成的離線API文檔





5、使用TableGo的自定義模板功能還能生成Markdown格式的離線API文檔
