当前位置: 首页 > 图灵资讯 > 技术篇> 开源|Apipost IDEA插件来啦!Upload一下即可生成API文档

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

来源:图灵教育
时间:2023-05-26 09:45:00

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. 下载插件(目前支持21.3以上版本的安装使用)

链接:https://pan.baidu.com/s/1XXKnb-Ozbkjis31bb

提取码:post

  1. 安装插件

点击Idea插件,通过本地磁盘安装。

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

  1. 确认安装

Apipostt是否已安装在安装插件列表中-idea-helper。如下图所示:

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

配置方法:

安装成功后,将进行 IDEA 内的项目与 关联Apipost项目。Apipost 「项目设置」>「对外能力」>「open API」中复制 API-token、项目ID,然后进入IDEA设置界面 >「Apipost Config」 中填写 API-token、项目ID。

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

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

API代码编写和代码修改后,后端研发右键点击“Upload to Apipost可以。团队成员可以在那里。 Apipost 在同步后的最新API文档中看到。

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

使用Apipost IDEA Helper后的工作流程:
  • 后端开发者:在 IDEA 中安装 「Apipost IDEA Helper」,随时编写/调试,随时更新同步;
  • 前端开发者:在 Apipost 查看最新文档,调试界面,API Mock ;
  • 测试工程师:在 Apipost 获取最新接口信息,编制/保存测试用例,进行自动化测试。

只需一个「Apipost IDEA Helper」可以进行后端研发 IDEA 中完成 API 所有的团队合作工作。

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