WebAPI接口文档快速编写

发布时间 2023-09-12 18:09:05作者: MaQaQ

  近期项目使用了WebAPI,需要先给出接口文档,本着能省事就省事的原则,自然最好是能找到自动生成文档的方式。

  一、使用Apifox,官网写着这是个API一体化协作平台,说白了,对于我来说,这就是个测试工具+文档生成器。单纯用于测试的话是可以直接在线操作,但如果想导出文档的话,还是需要下载桌面版软件的。

  Apifox软件的使用方法就不细说了,大概说一下步骤:

  • 在接口管理中

  1、点击数据模型的+,添加自定义数据模型(ps:点击,可以快速生成模型,如果是mysql数据库就直接贴建表语句生成就可以了)

 

 

   2、点击接口的+,添加接口,在Body(选择json)/返回响应的根节点中可以选择上面创建的数据模型,可以快速添加字段,添加完成后点击保存

  •  在项目设置中

  1、点击导出数据,选择Markdown格式,点击导出

   到此为止,我们已经拿到了一份md格式的文档,但一般我们还需要Word或者PDF格式的,于是我们还需要再做进一步的转换。

  二、安装Pandoc

  直接去官网下载并安装Pandoc。

  三、安装Typora

  Typora我找了个破解版的1.5.8版本,教程在后面的参考文档中有。也可以直接去官网下载,试用15天。

  安装,破解,打开md文档,点击左上角文件-导出-Word,就可以直接生成Word文档了。

 

   四、结语

  懒得写...

 

工具下载链接:

Apifox官网  https://apifox.com/

Typora官网(中文站)下载地址 https://typoraio.cn/releases/all

Pandoc下载地址 https://github.com/jgm/pandoc/releases/tag/3.1.8

参考文档:

《如何将markdown文件转成word》http://www.taodudu.cc/news/show-6008196.html?action=onClick

《Typora破解激活(2023最新)教程》https://baijiahao.baidu.com/s?id=1769561278318801642&wfr=spider&for=pc