Idea集成Yapi插件实现自动生成接口文档

点击蓝色字关注我们！

一个努力中的公众号

长的好看的人都关注了

前言
    API接口在设计时往往需要编写大量的文档，而且编写完成后往往需要根据实际情况经常改动文档，这使得文档编写维护工作量相对较大，让很多的开发者都很头疼。此外，伴随着接口版本的迭代开发，接口文档也需要同步更新。而且接口开发完成以后，做接口测试会十分不方便，要是遇上接口数量多、参数负载的情况，那不仅不方便，测试工作量会重上加重。

    Yapi 可以帮助开发者轻松创建、发布和维护不同项目，不同平台的API。有了YAPI，我们可以很方便的测试、管理和维护多个项目的API接口，不像Swagger那样是随应用生和灭的(且线上环境下大多数须关闭)。
    Yapi 是一个独立的服务平台，但是仍需要手动维护相关接口文档，如果项目体量较大，接口繁杂过多就会让后续开发十分痛苦。
    那么这个时候如果可以自动生成相关接口文档，就势必成为了急需品、在Idea中有一款插件"easy-yapi",可以在保持代码零侵入的情况下得到相当完整的api文档, 但是特殊的需求还是需要部分特殊的注释/注解配合与之相对的是, 你可以灵活的运用配置规则来适应你的项目特性以减少代码侵入。

1. Idea安装插件：easy-yapi

2. 安装后重启Idea

3. 打开settings、在Other Settings下打开EasyApi菜单，配置Yapi服务器地址(只需要对应的ip与端口即可，不需要具体那个项目)

4. 打开对应需要生成Yapi文档的Controller、 同时按住Shift + Alt + E、会出现以下弹框

5. 选中需要生成的接口的方法、点击弹框右上角绿色钩子、会弹出一个输入框，让你输入Yapi对应项目下的token

6. 将Yapi上面的token复制、粘贴到Idea的弹框中

7. 点击ok 然后会在控制台打印输入生成结果，生成成功会打印success、如果生成失败：一般是Yapi服务器配置多了项目路径、或者是没有Yapi的操作权限

生成成功就会在Yapi上面自动创建好对应的接口文档