一.背景    

    当我们使用idea开发java程序后，往往需要整理程序的北向接口文档。如果使用手工方式维护文档，则效率低、易出错，因此常采用自动导出的方式来维护接口文档。传统的导出文档格式有swagger,markdown,postman等多种格式。

二.工具

   本程序采用idea的easyAPI插件来实现，导出格式为markdown

    1.安装

      如下图，在idea界面点击file->settigs->plugins->marketplace,在输入框输入easyApi，找到后点击Install即可，重启后生效。

     2.使用

   在北向接口文件中点击右键，然后EasyApi->Expot Markdown,即可将文件导出到指定的目录 

3.查看

   使用markdown文档查看工具比如typora,打开刚导出的文件，即可查看 

三. 代码

    上节中导出的北向接口在代码中需满足以下格式方可正常导出

1. 北向接口需使用spring mvc的注解，如@RestController等，如下图红框中的注解
2. 接口入参和出参必须包含明确的参数类，比如下图中红框内出参的导出后有详细参数，而红圈内的导出后则没有

四.总结

   通过这个工具，极大的提升了接口文档的维护效率和质量，值得大力推广和应用。