apifox idea插件 springboot java 后端生成api文档最好得解决方案

对于api文档信任大家都很熟悉,也用过许多swagger、apidoc、openapi等等,调试工具也用过许多,但是总是感觉麻烦了一些。

最近在写一个新的项目,用的springboot3.0+,knife4j用了4.1.0出现了各种问题,虽然最后解决了,但是总是感觉哪里不放心,每次升级版本都提心吊胆的,不升吧又想保持比较新。

最后尝试了一圈,找到一个低代码,高可用的方案,

apifox+idea插件

这种方式简单粗暴,低代码侵入,或者说无需代码侵入,只要注释写的好,可以直接用。

目前没有遇到新的问题,文档生成简单,接口调试方便,文档可以分享给前端,也可以作为团队成员分享项目给前端。

1.扩展配置@ApiImplicitParam等时,我不想引入swagger包,所以我自己创建了一个包放swagger的annotations

只是把swagger中的代码copy过来就好了。

apifox idea插件 springboot java 后端生成api文档最好得解决方案

2.在idea中把这个勾上,配合@ApiImplicitParams,对于公共参数类,可以自定义文档需要的字段

apifox idea插件 springboot java 后端生成api文档最好得解决方案

3. 上传目录配置,只需要在类的注释通过/连接多级目录

/**

* ERP系统设置/权限管理/用户角色菜单

*/

© 版权声明

相关文章

暂无评论

您必须登录才能参与评论!
立即登录
none
暂无评论...