# RestfulBox

**Repository Path**: newhoo/RestfulBox

## Basic Information

- **Project Name**: RestfulBox
- **Description**: 一套功能强大的 Restful 开发工具集
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://plugins.jetbrains.com/plugin/14723-restfulbox
- **GVP Project**: No

## Statistics

- **Stars**: 12
- **Forks**: 6
- **Created**: 2022-01-11
- **Last Updated**: 2025-06-26

## Categories & Tags

**Categories**: restful

**Tags**: IDEA, SpringBoot, Spring-MVC, restful, API

## README

# 一套功能强大的 Restful 开发工具集

[英文](./README.md) | [Github](https://github.com/newhoo/RestfulBox) | [Gitee](https://gitee.com/newhoo/RestfulBox) | [Jetbrains](https://plugins.jetbrains.com/plugin/14723-restfulbox/reviews) | [界面展示](doc/zh_CN/界面展示.md)

**RestfulBox**插件致力于提升开发效率，只有实用常用好用的功能，丰富且完善的功能极大地提高了使用IDE开发的效率。

## 特性 ([6.0升级指南](doc/zh_CN/快速入门/6.0升级指南.md))
- [x] 支持更多的jetbrains产品，不仅仅是idea
- [x] 接口管理：接口自动扫描、展示、跳转和导入导出
  - 原生 Search Everywhere 支持搜索嗽口 (<kbd>Ctrl \\</kbd> or <kbd>Ctrl Alt N</kbd>)
  - 跨IDE跨项目同时浏览所有接口
  - 窗口显示多层级接口树
  - URL 和 Method 相互跳转
- [x] 强大好用的请求工具：
  - 多标签：可同时展示、发起多个请求、发起并发请求
  - 多协议：默认支持 http，支持SSE推送，可扩展支持 Dubbo 等
  - 自定义参数格式，支持占位符变量，自动格式化
  - 环境变量：支持变量使用、管理及迁移，提供内置函数和脚本函数
  - 全局请求头：支持和环境变量一起使用，提供内置函数和脚本函数
  - 参数库：支持Headers、Params、Body等参数展示、保存和删除
  - 请求脚本：支持前置/后置请求脚本
  - 请求响应信息展示报文格式，支持保存到日志文件
- [x] 语言和框架：
  - idea默认支持 SpringMvc / OpenFeign / Jax-RS 体系接口 (Java and Kotlin)
- [x] 数据源: 支持多种数据源存储数据，更安全更可控，可本地可云端同步可定制
- [x] 插件扩展：提供多个扩展点，便于自定义需求的实现
- [X] 拥有便捷的工具箱（时间转换、加解密、进制转换等）
- [X] 独创命令中心，支持丰富的自定义命令
- [X] 便捷的 IDE 项目切换管理
- [X] 支持自动识别并打开远程git仓库
- [X] 支持分组管理运行时的环境变量(IDEA/Goland/Android Studio中可用)
- [X] 额外：自动输出mysql执行计划和原始日志: <a href="https://github.com/newhoo/mysql-explain">MySQL Explain</a>
- [X] 额外：便捷的spring bean方法调用: <a href="https://github.com/newhoo/bean-invoker">Spring Bean Invoker</a>

## 生态

通过公开的扩展点，可以轻松实现一些自定义需求，具体参考生态章节。当前已支持：
- 扫描类型
  - [x] Spring MVC：默认支持，支持Java and Kotlin实现
  - [x] Jax-RS：从`3.3.0`开始默认支持，支持Java and Kotlin实现
  - [x] OpenFeign：从`5.7.0`开始默认支持，支持Java and Kotlin实现
  - [x] Dubbo：通过插件支持，见 [RestfulBox-Dubbo](https://github.com/newhoo/RestfulBox-Dubbo) ，支持扫描和发送请求
  - [x] Solon：通过插件支持，见 [RestfulBox-Solon](https://github.com/newhoo/RestfulBox-Solon) ，支持扫描和请求发送
  - [x] K8s：从`6.0.0`开始默认支持，支持扫描项目中的 K8s 部署文件
- 协议类型
  - [x] HTTP/HTTPS：默认支持
  - [x] DUBBO：同上
  - [x] Redis：支持简单的redis命令发送 [RESTKit-Redis](https://github.com/newhoo/RESTKit-Redis)
- 数据源（支持存储插件的所有数据到数据库）
  - [x] Sqlite数据源：默认`3.0.0`开始支持
  - [x] MySQL数据源：默认`3.0.1`开始支持

## 使用文档
- [中文文档-Github](https://github.com/newhoo/RestfulBox/blob/main/doc/zh_CN/%E7%9B%AE%E5%BD%95.md)  [Gitee](https://gitee.com/newhoo/RestfulBox/blob/main/doc/zh_CN/%E7%9B%AE%E5%BD%95.md)
- [English Document](doc/en/README.md)
- [CHANGELOG](doc/CHANGELOG.md)

## 关于插件
该插件的所有功能源于我本人日常开发中的点点滴滴，持续维护，为爱发电。请各位大佬支持一下，点亮小星星，同时也欢迎提供宝贵的建议。:star2:

[Issues](https://github.com/newhoo/RestfulBox/issues) | [Email](mailto:dev2n@qq.com) | [Jetbrains评分](https://plugins.jetbrains.com/plugin/14723-restfulbox/reviews)

> 注意  
> 反馈时请务必附上必要信息：Idea版本、插件版本、异常内容、复现方式、诉求等。


## 支持作者
你的支持是鼓励我前行的动力，非常感谢~

![赞助](doc/en/images/pay.png)