当前位置: 首页 > 后端技术 > Java

ApifoxIDEA插件-帮助开发者快速生成API文档!

时间:2023-04-01 19:16:04 Java

Apifox推出IDEA插件“ApifoxHelper”。ApifoxHelper是集成在IDEA中的一个方便的工具,可以帮助开发者自动解析代码注解,快速生成API文档。ApifoxHelper基于javadoc(Java)、KDoc(Kotlin)、ScalaDoc(Scala)解析API文档,支持SpringBoot、Swagger、JAX-RS等协议框架,基本可以自动生成接口文档,零代码侵入。在IDEA中使用ApifoxHelper可以一键同步文档到Apifox项目,开发者无需切换工具即可更新同步文档到团队其他成员。自动解析注释、快速同步文档、在IDEA中调试、便捷的Apifox团队协作,你只需要一个“Apifox帮手”。接下来,我将向您展示如何使用它。安装和配置首先,您需要在IntelliJIDEA中安装和配置令牌。打开首选项(设置)>插件,搜索ApifoxHelper并单击安装。您也可以从JetbrainsMarketplace官网下载安装。安装成功后,要将IDEA中的项目关联到Apifox的项目中,需要配置token。进入设置界面Preferences(Settings)>ApifoxHelper填写Apifox服务器地址,个人accesstoken,项目ID:Apifox服务器地址:默认ApifoxAPI服务地址为https://api.apifox.cn,不需要调整。ApifoxPersonalAccessToken:在Apifox头像的“账户设置-->API访问令牌”,新建一个token,复制生成的Token填写。模块项目ID配置:这里主要是配置映射关系代码模块名称和项目ID。在Apifox中,进入项目“ProjectSettings-->BasicSettings”,复制项目ID并粘贴。完成以上配置操作后,即可实现文档自动生成、同步、在线调试、导入导出等功能。自动生成API文档使用“ApifoxHelper”直接自动解析代码注解,零代码入侵。右键“上传到Apifox”生成完整的API文档,无需导出即可同步到Apifox项目中。团队成员可以在Apifox项目中完成接口调试、自动化测试等。界面信息一键更新同步当IDEA项目中有界面信息变化时,只需右键“上传到Apifox”即可完成同步,无需东奔西跑告诉对方。团队成员可以在Apifox同步后看到最新的内容。此外,使用ApifoxHelper,可以在IDEA中一键启动内部接口测试,同时支持导出Markdown格式文档和cURL,适应不同团队的协作方式。结合IDEA插件,推荐code-first团队API协作实践如下:后端开发者:在IDEA中安装“ApifoxHelper”,随时编写/调试,随时更新同步;前端开发者:查看Apifox最新文档,进行接口调试和APIMock;测试工程师:获取Apifox最新接口信息,编写/保存测试用例,进行自动化测试。让后端开发者只需要一个“ApifoxHelper”就可以完成IDEA中API协作所需的工作。现在去,在IDEA的“插件”入口搜索“ApifoxHelper”,下载试试吧!如果你想了解更多关于该插件的信息,可以查看Apifox官方帮助文档。除了IDEA插件,我们近期还新增了很多其他功能,欢迎了解:Apifox产品1月新功能解读。