From de83a3cbbad03ce7f800645eb501b97000be5044 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Sat, 21 Jun 2025 04:42:19 +0000 Subject: [PATCH] Update README.md --- db/README.md | 126 +++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 107 insertions(+), 19 deletions(-) diff --git a/db/README.md b/db/README.md index 0ce8d07e..d51427f3 100644 --- a/db/README.md +++ b/db/README.md @@ -1,21 +1,109 @@ -> 0.7.x版本之后仅需要一张表两个字段，建表语句如下： -```sql -CREATE TABLE `magic_api_file_v2` ( - `file_path` varchar(512) NOT NULL, - `file_content` mediumtext, - PRIMARY KEY (`file_path`) -) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 + + +# MagicAPI 多模块接口快速开发平台 + +## � +[![Gitee stars](https://gitee.com/ssssssss/magic-api/badge/star.svg)](https://gitee.com/ssssssss/magic-api) +[![Gitee forks](https://gitee.com/ssssssss/magic-api/badge/fork.svg)](https://gitee.com/ssssssss/magic-api) + +## 简介 +MagicAPI 是一个基于 SpringBoot 的接口快速开发平台，通过可视化 UI 界面编写接口，无需定义 Controller、Service、MyBatis 策略、XML、DAO 等 Java 后端工程代码，通过功能模块化设计，可快速实现接口开发需求。 + +## 特性 +- **可视化编辑**：在线脚本编辑器，支持断点调试 +- **模块支持**：支持 Redis、MongoDB、Elasticsearch 等多种数据库操作 +- **数据源管理**：支持多数据源配置及动态切换 +- **接口文档**：自动生成 Swagger/OpenAPI 文档 +- **集群部署**：支持通过 Redis 实现集群环境下的数据同步 +- **Git 版本管理**：支持接口文件的 Git 版本控制 +- **定时任务**：内置 Quartz 定时任务模块 +- **脚本语言**：支持 JSR223 脚本语言扩展 +- **安全控制**：支持基础认证和权限管理 +- **跨域支持**：内置 CORS 过滤器 +- **日志管理**：集成 Logback/Log4j2 日志输出 + +## 快速开始 + +### Maven 引入 +```xml + + org.ssssssss + magic-api-spring-boot-starter + 1.0.0 + ``` -### 备份表建表语句 -```sql -CREATE TABLE `magic_backup_record_v2` ( - `id` varchar(32) NOT NULL COMMENT '原对象ID', - `create_date` bigint(13) NOT NULL COMMENT '备份时间', - `tag` varchar(32) DEFAULT NULL COMMENT '标签', - `type` varchar(32) DEFAULT NULL COMMENT '类型', - `name` varchar(64) DEFAULT NULL COMMENT '原名称', - `content` blob COMMENT '备份内容', - `create_by` varchar(64) DEFAULT NULL COMMENT '操作人', - PRIMARY KEY (`id`,`create_date`) -) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 + +### application.properties 配置示例 +```properties +# 接口访问路径 +magic-api.prefix=/magic +# 数据库存储 +magic-api.resource.type=database +magic-api.datasource=your_datasource_key +# 启用 Swagger 文档 +springdoc.api-docs.enabled=true +# Redis 配置 +magic-api.resource.type=redis +# MongoDB 配置 +magic-api.resource.type=mongo +# Git 配置 +magic-api.resource.type=git +magic-api.resource.git.url=your_git_url +magic-api.resource.git.branch=your_git_branch +# MagicAPI 工作空间（默认为 classpath:magic-api） +magic-api.resource.location=classpath:magic-api +# 跨域设置 +magic-api.support-cross-domain=true +# 安全设置 +magic-api.security.username=admin +magic-api.security.password=admin +# 定时任务设置 +magic-api.task.enable=true +# 缓存设置 +magic-api.cache.enable=true +magic-api.cache.ttl=3600 +magic-api.cache.capacity=100 ``` + +### Web 页面入口 +MagicAPI 的 Web 控制台默认路径为 `/magic`，可通过以下方式访问： +``` +http://localhost:8080/magic +``` +默认登录用户名/密码：`admin`/`admin`（如果启用安全功能） + +### 文件存储位置 +支持多种存储方式： +- `file`: 文件系统存储 +- `database`: 数据库存储 +- `redis`: Redis 存储 +- `git`: Git 版本存储 + +当路径以 `classpath:` 开头时为只读模式，例如： +```properties +magic-api.resource.location=classpath:magic-api +``` + +## 在线编辑 +MagicAPI 提供在线编辑器，支持： +- 接口定义 +- 脚本编写（支持 Java、Groovy、JavaScript �://sss +ssss/magic-api) +- [官方文档](https://magic-api.com) +- [Gitee 项目](https://gitee.com/ssssssss/magic-api) +- [GitHub 项目](https://github.com/ssssssss/magic-api) + +## 示例项目 +- [magic-api-example](https://gitee.com/ssssssss/magic-api-example) + +## 项目截图 +![MagicAPI 控制台截图](magic-editor/src/main/resources/magic-editor/assets/logo-magic-api.7bf52c65.png) + +## 交流群 +加入我们的交流群获取更多帮助： +- QQ 群：1060542984 +- 微信群：添加微信 `magicapi` 进群 + +--- + +> 本项目遵循 Apache 2.0 开源协议，欢迎贡献代码和提出建议。 \ No newline at end of file -- Gitee