开源|Apipost IDEA插件来啦!Upload一下即可生成API文档

IDEA 开源插件 「Apipost IDEA Helper」现已上线 !自动解析注解、快速同步文档、IDEA 内调试、高效协作,现在只需一个「Apipost IDEA Helper」!

Apipost IDEA Helper 集成在 IDEA 中,基于 javadoc(Java)、KDoc(Kotlin)、ScalaDoc(Scala)解析 API 文档,在后端研发完成API编写后,只需在IDEA中右键点击“Upload to Apipost”,即可快速生成完整的API文档并同步到Apipost项目中,无需导出操作。开源|Apipost IDEA插件来啦!Upload一下即可生成API文档_第1张图片

 

下载安装:

  1. 下载插件,(目前支持21.3以上版本安装使用哦)

链接:https://pan.baidu.com/s/1XXKnB-OzBkXjis31bb0Ofw

提取码:post

  1. 安装插件

点击Idea插件,通过本地磁盘安装。开源|Apipost IDEA插件来啦!Upload一下即可生成API文档_第2张图片

 

  1. 确认安装

在安装插件列表确认是否已经安装了Apipost-idea-helper。如下图所示:开源|Apipost IDEA插件来啦!Upload一下即可生成API文档_第3张图片

 

配置方法:

安装成功后要将 IDEA 内的项目与 Apipost的项目进行关联。在Apipost 「项目设置」>「对外能力」>「open API」中复制 API-token、项目ID,再进入IDEA设置界面 >「Apipost Config」 中填写 API-token、项目ID。开源|Apipost IDEA插件来啦!Upload一下即可生成API文档_第4张图片

 

一键生成或同步接口文档:

后端研发在API代码编写、代码修改后右键点击“Upload to Apipost”即可。团队成员可在 Apipost 中看到同步后的最新API文档。开源|Apipost IDEA插件来啦!Upload一下即可生成API文档_第5张图片

 

使用Apipost IDEA Helper后的工作流程:

  • 后端开发者:在 IDEA 中安装 「Apipost IDEA Helper」,随时编写/调试,随时更新同步;

  • 前端开发者:在 Apipost 中查看最新文档,进行接口调试、API Mock ;

  • 测试工程师:在 Apipost 中获取最新接口信息,编写/保存测试用例、进行自动化测试。

只需一个「Apipost IDEA Helper」后端研发即可在 IDEA 中完成 API 团队协作中所有工作。开源|Apipost IDEA插件来啦!Upload一下即可生成API文档_第6张图片

 

你可能感兴趣的:(intellij-idea,java,ide)