Apikit Plugin

Eolink ApiKit 插件，用于解析 Java 代码并上传 API 文档到 Eolink 平台。

功能

编辑页右键菜单

1. [Apikit] Upload Api（解析 & 预览单文件Api）
2. [Apikit] Upload All Api（解析 & 上传单文件全部Api）
3. [Apikit] Generate Class Doc（自动生成插件注释）
   3.1 HTTP（生成HTTP插件注释）
   3.2 RPC（生成RPC插件注释）
   3.3 Remove Doc（移除插件注释）

文件夹右键菜单

1. [Apikit] Generate Dir Class Doc（批量自动生成插件注释） 3.1 HTTP（生成HTTP插件注释）
   3.2 RPC（生成RPC插件注释）
   3.3 Remove Doc（移除插件注释）

命令（Ctrl + Shift + p）

• 部分关键字即可搜索执行，如“apikitconf”，“apikitall”

1. apikit-plugin.configureUploadSettings
   • 输入web端项目内任意接口自动完成配置
   • 个人token需要补充
2. apikit-plugin.parseAndUploadAllProject
   • 解析 & 上传整个项目所有Api

使用要求

1. VS Code 1.100.0 或更高版本
2. Java 项目
3. JDK 17+
4. Eolink 账号和 API Token

• 更好的解析效果
  • 若为maven项目请确保系统以安装maven且在控制台中能使用“mvn -v”输出maven信息
  • 若为gradle项目请确保项目内能使用“gradle build”进行构建
  • maven或gradle正确的配置私有仓库地址

扩展设置

本扩展提供以下配置项：

• apikitPlugin.basic.server: 服务器地址
• apikitPlugin.basic.workspaceId: 空间 ID
• apikitPlugin.basic.projectId: 项目 ID
• apikitPlugin.basic.token: 个人密钥
• apikitPlugin.basic.branch: 分支名
• apikitPlugin.basic.autoAddSlash: 前缀自动添加路径斜杠
• apikitPlugin.basic.groupSplitType: 分组依据
• apikitPlugin.basic.formatType: 参数名格式化方式
• apikitPlugin.annotation: 自定义注释注解

更多配置项请查看设置页面。

已知问题

暂无已知问题。

版本说明

1.0.0

1. Eolink Vscode 插件正式上线