如何快速写文档

Posted 2022-03-29 我永远信仰

后端开发人员写文档，可以借助工具，快速生成文档。
本文主要介绍生成到yapi
环境：
● idea2020.1
● 插件 POJO TO JSON
● 插件 EasyYapi
使用EasyYapi的优势：可以导出Markdown文档，可以兼容许多地方，只需要将Mackdown粘贴到需要的地方即可

安装好插件重启后，配置好easyapi

路径获取

token值得获取

然后定位到需要生成的controller -->右键 ，选择导出MD文件

选择文件的存放路径

就能得到一个md接口文档

如果需要生成到yapi上 就选择

会让输入一次token，将刚才得token粘贴一次就行了

控制台打印成功，点击超链接即可快速传送

这个方式会少了json格式，所以需要pojo to jaso

定位到返回前端的实体类，然后点击

自动生成json到剪切板，ctrl+v即可,然后再将这个粘贴到yapi文档里就完成了一个接口文档的书写。

  "name": "",
  "age": 0

注意：关于文档中生成的注释，会根据/** */ 的注解去自动生成，所以需要多写一些注释才能生成出来，这是任何方法都不可避免的。

以上两种方法结合，能解决很大一部分需求，但是不免有些繁琐。但对我的需求场景来说是蛮好的

也可以使用最近挺火的应用来一次性生成文档。
Apifox或者ApiPost，关于他们俩网上的教程实在太多了，确实挺好用的，可以自寻资源。