swagger json导出word,Typora软件推荐!!!
阅读原文时间:2023年07月09日阅读:3

  前几天项目验收,赶了一整天补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》

手机扫一扫

移动阅读更方便

阿里云服务器
腾讯云服务器
七牛云服务器