# 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)

[中文](README_zh_CN.md)

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

## What is RestfulToolkitX?

[RestfulToolkitX][upstream] is an awesome RESTful development toolkit for IntelliJ IDEA, originally forked from [RestfulToolkit][RestfulToolkit] which is no longer maintained.

This repository is a secondary fork based on [huangbaihua001/RestfulToolkitX][upstream], adapted to support **IntelliJ IDEA 2024.2 ~ 2026**. Key changes include migrating to the new IntelliJ Platform Gradle Plugin 2.x, upgrading to JDK 17 / Kotlin 1.9 / Gradle 8.12, and fixing various compatibility issues with IDEA 2026.

## Features

- [x] Supports Java and Kotlin languages, Spring framework (Spring Boot / Spring MVC), JAX-RS, Jakarta EE.
- [x] Quick search url to navigate to service declaration. ( use: `Ctrl + \` or `Ctrl + Alt + B` )
- [x] Show Restful services structure in a tree navigator.
- [x] A simple http request tool.
- [x] Generate & Copy Full URL / Relative URL / Query Param / Request Body (JSON) on the request method.
- [x] Convert Java/Kotlin class to JSON; format JSON data ( Windows: `Ctrl + Enter`; Mac: `Command + Enter` )

Quick Search URL Preview

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

Restful Services Window Preview

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

Useful Functions Preview

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


## Compatibility

| Version | IDEA Version | Java | Gradle | IntelliJ Platform Plugin |
|---------|-------------|------|--------|--------------------------|
| 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 |


## Build Environment

To build this plugin from source, you need:

- **JDK 17** or higher (required by IntelliJ Platform SDK 2024.2+)
- **Gradle 8.12** (included via Gradle Wrapper, no manual install needed)
- **IntelliJ IDEA** (Community or Ultimate, for development and testing)

### Build Steps

```bash
# Clone the repository
git clone https://gitee.com/phubing/RestfulToolkitX-.git
cd RestfulToolkitX-

# Build the plugin (make sure JAVA_HOME points to JDK 17+)
./gradlew buildPlugin

# The plugin zip will be generated at build/distributions/RestfulToolkitX-2.2.0.zip
```

### Run / Debug in IDE

```bash
# Launch a sandbox IDEA instance with the plugin loaded
./gradlew runIde
```

### Important Notes

1. This project uses the new [IntelliJ Platform Gradle Plugin 2.x][platform-plugin] (`org.jetbrains.intellij.platform`), not the legacy `org.jetbrains.intellij` 1.x plugin. Refer to the [migration guide][migration-guide] if you are upgrading from an older version.
2. The `platformVersion` in `gradle.properties` is set to `2024.2`. The plugin is compatible with IDEA builds from `242` to `261.*`.
3. Make sure your `JAVA_HOME` points to JDK 17+. JDK 11 is no longer sufficient for building this version.
4. If you encounter Gradle configuration cache issues, try `./gradlew --no-configuration-cache buildPlugin`.


## Installation

- Using IDE built-in plugin system (if published):

  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "
  RestfulToolkitX"</kbd> >
  <kbd>Install Plugin</kbd>

- Install from local zip:

  Build the plugin from source (see above), or download from [Releases](https://gitee.com/phubing/RestfulToolkitX-/releases), then install:
  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd> > select `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