swagger json導出word,Typora軟件推薦!!!


場景:

  前幾天項目驗收,趕了一整天補API接口設計文檔,給爺整吐了。周末的時候就想能不能直接把swagger的json文件導出成word? 順便學習一下NPOI的使用。

實現思路:

  1.先把swaager.json中的文件進行json反序列化,解析成對象。

  2.用NPOI進行word的創建和內容的編寫。

結果:

  做了兩三天,最后結果可以正常解析swaager版本為3.0的json文件,然后導出word,word內容如圖:

  

  優點:導出的word有標題段落關系,格式清晰;把swaager.json中的有效信息都輸出到word了;

  不足:現在只支持POST,GET請求(因為項目只用到這兩種);返回的類應該有超鏈接到文檔中后面的變量表格,但是沒有實現。支持的swaager版本有限。

最后:

  當我好不容易做完了之后,我師兄過來一看,得知我在鼓搗swaager.json轉word然后他就說可以用YAPi導出Markdown文件,然后用Typora轉成word!於是我們試了一下,用Typora打開文件如圖:

  然后導出為word,結果:

  虎軀一震!!!感覺軟件導出的word比我自己程序導出的好看,而且也保留了標題關系。還好word中表結構不是很清晰。然后師兄說:“那我們導出pdf試試!”結果:

  納尼(ÒωÓױ)!這玩意還能導出pdf!!??這效果也太好了吧!!!總結,接口文檔還是用YAPI導出markdown然后用Typora導出pdf。

  最后分享一下自己寫的程序接口的倉庫地址:https://gitee.com/chen_chongpo/study.git

  項目在《后端》文件夾中的《JsonToWord》


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM