在做項目時通常需要給客户提供離線Word的API文檔歸檔,不要跟客户説有Swagger在線API文檔,客户不會用也不會去看。只要你有Swagger,TableGo就能自動生成一份漂亮的Word離線API文檔給客户,大大提高了寫文檔的效率,客户看了高興,大家項目交付的速度也快很多。支持Swagger2和Swagger3 OpenAPI3,使用TableGo的自定義模板功能還能生成Markdown格式的離線API文檔。
1、首先打開Swagger找到api-docs的訪問地址,這個地址提供了Swagger的文檔JSON數據,離線文檔就是利用這些JSON數據來生成的
2、打開TableGo,找到並打開生成工具 → 生成自定義文件 → Swagger
3、將api-docs的訪問地址填入“在線訪問地址”,也可以把api-docs的JSON數據保存到本地JSON文件中,選擇離線JSON數據文件
配置文檔標題,文檔標題用於生成文件名和文檔標題,title對應“info.title”,description對應“info.description”
如果只想生成指定模塊的API數據,可以在模板設置中選擇需要的模塊
點擊“生成Word離線API文檔”按鈕即可生成文檔
4、打開Document目錄,查看剛生成的離線API文檔
5、使用TableGo的自定義模板功能還能生成Markdown格式的離線API文檔
http://www.tablego.cn
https://gitee.com/vipbooks/TableGo
https://github.com/vipbooks/TableGo