最近负责的一个项目，需要提供一些接口给第三方平台。但之前的接口文档没有或者文档散落在不同的wiki上。导致需要花费一些额外的工作时间来进行接口文档编写！
为了减少后期有可能出现的接口文档，我推荐使用YAPI。
https://hellosean1025.github.io/yapi/
yapi支持多种格式文档的导出，也支持特定接口的导出（将特定的接口设置为公开接口）
支持多种格式文档的导出
支持部分接口的导出
同时，idea有相关插件，方便开发人员将接口直接一键同步到yapi。
搜索插件：Idea YApi，进行安装
idea插件
以JSON格式配置项目
选择方法（类），右键选择Idea Yapi即可完成接口文档的同步
接口同步示例
接口定义
接口注释需要体现出对应的模块。如：资产管理-数据源管理-数据源配置。取最后一个数据源配置即可，便于接口查找
接口代码
最终同步效果为：
