每个开发人员都不想写文档。当你不想写接口文档的时候，可以在IDEA中安装插件实现自动同步，一边写代码一边同步接口文档给你的前端和测试同学。下面的内容教大家如何操作（这里只针对使用IDEA编辑器，遵循JavaSpring框架注解规范的同学）：首先，你需要安装一个插件。在IDEA插件市场搜索“ApifoxHelper”。这是一款国内API协作管理平台（Apifox）厂商制作的插件，可以非常方便的自动生成接口文档并同步到你的项目中。本插件可自动生成接口文档，零代码侵入。IDEA安装插件：打开IDEA>Preferences(Settings)>Plugins，搜索ApifoxHelper，点击Install。如果这里安装速度慢，也可以去JetbrainsMarketplace官网下载。安装完成后可以选择同步到Apifox项目，也可以直接导出markdown文档。如果同步到Apifox项目，还需要下载或注册Apifox软件，并创建对应的项目：注册/下载地址：http://apifox.cn，直接微信扫一扫即可，非常简单。创建项目：点击CreateTeam>NewProject，填写相应的项目名称。（这里强烈建议同步到Apifox项目，后面会解释原因）第二步，在你的IDEA中成功安装项目和Apifox项目关联插件后，将IDEA中的项目关联到Apifox工程，需要配置命令卡。在IDEA中进入插件设置界面Preferences(Settings)>ApifoxHelper并填写。需要填写三个基本信息：Apifox服务器地址：默认的ApifoxAPI服务地址为https://api。apifox.cn，默认填写，无需修改。填写Apifox个人accesstoken：在Apifox个人头像的【账户设置】中选择【APIAccessToken】，新建一个token，复制生成的Token填写上面的插件设置。模块项目ID配置：这里主要是配置代码模块名称和项目ID的映射关系。在Apifox中对应项目的【项目设置】中选择【基本设置】，复制并保存项目ID，在上面的地方填写对应的模块名称。至此所有设置动作完成，可以实现文档的自动生成和更新同步。说明：每个项目一开始只需要设置一次，后面就不需要再做这个操作了。第三步，自动生成接口文档。打开要上传的Controller文件，右击选择“上传到Apifox”。进入Apifox项目，可以看到刚才自动同步的文档。后续接口代码有改动或更新时，再次点击“上传到Apifox”进行同步。为什么推荐创建Apifox项目？这个插件虽然支持导出markdown，但是分享文件给别人不是很方便，而且有更新不会同步，所以需要反复导出。使用Apifox项目，你可以直接分享一个链接给别人，你之后的界面更新会直接同步，对方看到的永远是最新的。此外，Apifox产品本身具有丰富的API调试、Mock、自动化测试等功能。你的前端和测试也可以直接在上面做后续工作。这里就不细说了，有兴趣的可以去他们的官方文档了解一下。有了这个插件，你也可以直接在IDEA中调试ApifoxHelper。支持在IDEA中一键界面自检，无需切换其他软件。在IDEA中选中需要调试的API文件，右键选择“调用API”发起请求。当然，以上只是一个简单版的自动同步文件，没有特殊情况都可以使用。当然也可能有一些特殊的要求，比如设置接口API所在的文件夹名称，想忽略一些不同步的API等等。在他们的官方文档中，推荐使用配置文件来实现你的各种特殊规则和要求。具体可以去Apifox官网查看。它与Swagger有何不同？许多开发人员习惯于使用Swagger。使用Swagger可以在一定程度上解决自动生成文档的问题，但是有一个很大的缺点：需要写很多注释，对你的逻辑代码有干扰。而且在功能上不如Apifox全面。Swagger：需要写注释，对逻辑代码有侵入，功能单一；Apifox：基本可以做到代码零侵入，使用标准Javadoc注释自动生成。同时还支持将Swagger文档同步到项目中。还有APIMock、自动化测试等扩展功能。推荐使用方式是省略Swagger这一步，直接安装这个插件。下载链接：www.apifox.cn
