1. magic介绍
magic 是一款提供在线便捷开发加测试的框架,使用该框架能够快速进行功能开发,并且同步到各个节点。
2. magic特点
- 嵌入spring boot
- 在线开发
- 自动化测试,开发完成即可直接测试
- 实时生效,并且swagger文档实时变化
3. 部署过程
引入相关jar包
<!-- magic-api 核心包 -->
<dependency>
<groupId>org.ssssssss</groupId>
<artifactId>magic-api-spring-boot-starter</artifactId>
<version>2.0.0</version>
</dependency>
<!-- magic-swagger 扩展包 -->
<dependency>
<groupId>org.ssssssss</groupId>
<artifactId>magic-api-plugin-swagger</artifactId>
<version>2.0.1</version>
</dependency>
引入之后直接就可以使用
启动项目之后的magic地址 http://localhost/magic/web/index.html
配置信息
magic-api:
# 远程推送时的秘钥,未配置则不开启推送
secret-key: 123456789
# web页面地址
web: /magic/web
# 数据库查询结果驼峰转换
sql-column-case: camel
resource:
# 本地存储使用,本地存储接口元数据信息,配置存储位置
# location: data/magic-api
# 配置存储到数据库中
type: database # 配置存储在数据库中
# 数据库中的表名
tableName: magic_api_file
#指定数据源(单数据源时无需配置,多数据源时默认使用主数据源,如果存在其他数据源中需要指定。)
# datasource: magic
# key前缀
# prefix: /magic-api
# 是否是只读模式
# readonly: false
4. 数据库脚本(采用数据库存储模式需要)
CREATE TABLE `magic_api_file`
(
`file_path` varchar(512) NOT NULL,
`file_content` mediumtext,
PRIMARY KEY (`file_path`)
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4;
CREATE TABLE `magic_api_backup`
(
`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` mediumtext COMMENT '备份内容',
`create_by` varchar(64) DEFAULT NULL COMMENT '操作人',
PRIMARY KEY (`id`, `create_date`)
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4;