# RestfulToolkitX

**Repository Path**: phubing/RestfulToolkitX-

## Basic Information

- **Project Name**: RestfulToolkitX
- **Description**: 基于 RestfulToolkitX 源码修改，由于原组件不更新已有一段时间，最近升级了 Idea 2026 版，发现该工具不支持新版，故下载了源码进行新版本的适配
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-15
- **Last Updated**: 2026-04-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Restful Toolkit For IntelliJ IDEA

![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)

[English](README.md)

![logo.png](img/logo2.png)

## RestfulToolkitX 是什么？

[RestfulToolkitX][upstream] 是一个运行在 IntelliJ IDEA 上的 RESTful 开发工具包，最初 Fork 自已停止维护的 [RestfulToolkit][RestfulToolkit]。

本仓库是基于 [huangbaihua001/RestfulToolkitX][upstream] 的二次 Fork，适配了 **IntelliJ IDEA 2024.2 ~ 2026**。主要变更包括：迁移到新版 IntelliJ Platform Gradle Plugin 2.x、升级 JDK 17 / Kotlin 1.9 / Gradle 8.12，以及修复了多处 IDEA 2026 兼容性问题。

---

## 功能及特性

- [x] 支持 Java 及 Kotlin 语言，Spring framework (Spring Boot / Spring MVC)，JAX-RS，Jakarta EE
- [x] 快捷搜索 REST URL 并直接定位到相应服务，比 IDEA 自带的 Search Anywhere 更快（使用: `Ctrl + \` 或 `Ctrl + Alt + B`）
- [x] 一个导航窗口，用于显示 REST 服务的层次结构
- [x] 一个简单的 HttpClient 工具
- [x] 在请求方法上生成并复制完整 URL / 相对 URL / Query 参数 / RequestBody (JSON)
- [x] 将 Java/Kotlin 类转成 JSON；格式化 JSON 数据（Windows: `Ctrl + Enter`；Mac: `Command + Enter`）

快捷搜索 URL 预览

![searchService.png](img/searchService.png)

Restful 服务窗口预览

![restServiceWindow.png](img/rest_resp_highlight.png)

实用功能预览

![gen_copy.png](img/gen_copy.png)
![convert_json.png](img/convert_json.png)


## 兼容性

| 版本 | IDEA 版本 | Java | Gradle | IntelliJ Platform 插件 |
|------|----------|------|--------|------------------------|
| 2.2.0  | 2024.2 ~ 2026.* | 17   | 8.12   | `org.jetbrains.intellij.platform` 2.11.0 |
| 2.1.10 | 2020.2 ~ 2024.3 | 11   | 8.0.2  | `org.jetbrains.intellij` 1.13.2 |


## 编译环境

从源码构建本插件，需要以下环境：

- **JDK 17** 或更高版本（IntelliJ Platform SDK 2024.2+ 要求 JDK 17）
- **Gradle 8.12**（项目已包含 Gradle Wrapper，无需手动安装）
- **IntelliJ IDEA**（Community 或 Ultimate 版，用于开发和调试）

### 构建步骤

```bash
# 克隆仓库
git clone https://gitee.com/phubing/RestfulToolkitX-.git
cd RestfulToolkitX-

# 构建插件（确保 JAVA_HOME 指向 JDK 17+）
./gradlew buildPlugin

# 插件 zip 包将生成在 build/distributions/RestfulToolkitX-2.2.0.zip
```

### 运行 / 调试

```bash
# 启动一个沙箱 IDEA 实例，自动加载本插件
./gradlew runIde
```

### 注意事项

1. 本项目使用新版 [IntelliJ Platform Gradle Plugin 2.x][platform-plugin]（`org.jetbrains.intellij.platform`），而非旧版 `org.jetbrains.intellij` 1.x 插件。如果你从旧版本升级，请参考 [迁移指南][migration-guide]。
2. `gradle.properties` 中的 `platformVersion` 设置为 `2024.2`，插件兼容 IDEA 构建号 `242` 到 `261.*`。
3. 请确保 `JAVA_HOME` 指向 JDK 17+，JDK 11 已不再满足本版本的构建要求。
4. 如果遇到 Gradle 配置缓存问题，可尝试 `./gradlew --no-configuration-cache buildPlugin`。


## 安装

- IDE 插件市场安装（如已发布）:

  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>搜索 "
  RestfulToolkitX"</kbd> >
  <kbd>安装插件</kbd>

- 本地 zip 安装:

  从源码构建插件（参考上方步骤），或从 [Releases](https://gitee.com/phubing/RestfulToolkitX-/releases) 下载，然后安装:
  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd> > 选择 `RestfulToolkitX-2.2.0.zip`


## License

RestfulToolkitX is under the Apache 2.0 license. See the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) file for details.

---
Plugin based on the [IntelliJ Platform Plugin Template][template]

[template]: https://github.com/JetBrains/intellij-platform-plugin-template
[RestfulToolkit]: https://github.com/mrmanzhaow/RestfulToolkit
[upstream]: https://github.com/huangbaihua001/RestfulToolkitX
[platform-plugin]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin.html
[migration-guide]: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-migration.html