Idea插件 【easyYapi】接口文档生成

[温暖的火龙果687]

痛点：

编写接口文档不注意字段遗漏
CV内容漏改
和实际出入参键值不对应，数据类型不对应，注释说明不对应
swagger侵入性太强

安装：

使用

鼠标右击或者快捷键【alt+Insert】选择EasyApi即可，能生成markdown接口文档，也可直接提交到yapi平台

缺点

只能一个个的controller生成，没办法一个项目整体生成
没有controller的覆盖逻辑，只有接口法覆盖逻辑，如需删除接口，只能通过yapi进行接口删除

[重复过往]

好！

[流浪法师刘海柱]

很好

[Jetbrains 中国]

实际上我在项目的搭建也是不推荐swagger，因为侵入性太强了，也并没有很高效的提高前后端联调水平。

更推荐ApiFox和ApiPost这种在线工具（公司已禁用），可以通过idea插件的形式形成在线协同文档，而且不限团队人数。可能缺点就是保密问题。

还有一种离线的文档生成插件，也比较推荐，原理是通过内置的maven插件来实现文档生成，插件名：smart-doc，可以一试！