Skip to content

Commit aecaeb8

Browse files
committed
update README
1 parent e4b5135 commit aecaeb8

1 file changed

Lines changed: 32 additions & 55 deletions

File tree

README.md

Lines changed: 32 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,31 @@
33
</p>
44
<p align="center">
55
<a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html"><img src="https://img.shields.io/badge/JDK-1.8+-green.svg" /></a>
6-
<a href="https://search.maven.org/search?q=g:org.ssssssss%20AND%20a:magic-api-spring-boot-starter">
7-
<img alt="maven" src="https://img.shields.io/maven-central/v/org.ssssssss/magic-api-spring-boot-starter.svg?style=flat-square">
6+
<a href="https://search.maven.org/search?q=g:org.ssssssss%20AND%20a:magic-api">
7+
<img alt="maven" src="https://img.shields.io/maven-central/v/org.ssssssss/magic-api.svg?style=flat-square">
88
</a>
99
<a target="_blank" href="https://www.ssssssss.org"><img src="https://img.shields.io/badge/Docs-latest-blue.svg"/></a>
10-
<a target="_blank" href="https://github.com/ssssssss-team/magic-api-spring-boot-starter/releases"><img src="https://img.shields.io/github/v/release/ssssssss-team/magic-api-spring-boot-starter?logo=github"></a>
11-
<a target="_blank" href='https://gitee.com/ssssssss-team/magic-api-spring-boot-starter'><img src="https://gitee.com/ssssssss-team/magic-api-spring-boot-starter/badge/star.svg?theme=white" /></a>
12-
<a target="_blank" href='https://github.com/ssssssss-team/magic-api-spring-boot-starter'><img src="https://img.shields.io/github/stars/ssssssss-team/magic-api-spring-boot-starter.svg?style=social"/></a>
10+
<a target="_blank" href="https://github.com/ssssssss-team/magic-api/releases"><img src="https://img.shields.io/github/v/release/ssssssss-team/magic-api?logo=github"></a>
11+
<a target="_blank" href='https://gitee.com/ssssssss-team/magic-api'><img src="https://gitee.com/ssssssss-team/magic-api/badge/star.svg?theme=white" /></a>
12+
<a target="_blank" href='https://github.com/ssssssss-team/magic-api'><img src="https://img.shields.io/github/stars/ssssssss-team/magic-api.svg?style=social"/></a>
1313
<a target="_blank" href="LICENSE"><img src="https://img.shields.io/:license-MIT-blue.svg"></a>
1414
<a target="_blank" href="https://shang.qq.com/wpa/qunwpa?idkey=10faa4cf9743e0aa379a72f2ad12a9e576c81462742143c8f3391b52e8c3ed8d"><img src="https://img.shields.io/badge/Join-QQGroup-blue"></a>
1515
</p>
1616

17-
[特性](#特性) | [快速开始](#快速开始) | <a target="_blank" href="http://ssssssss.org">文档</a> | <a target="_blank" href="http://ssssssss.org/changelog.html">更新日志</a> | [其它开源](#其它开源项目)
17+
[特性](#特性) | [快速开始](#快速开始) | <a target="_blank" href="http://ssssssss.org">文档</a> | <a target="_blank" href="http://ssssssss.org/changelog.html">更新日志</a> | [项目截图](#项目截图) | [其它开源](#其它开源项目)
1818

1919
# 特性
20-
- 以XML为基础,自动映射HTTP接口
21-
- 支持MySQL、MariaDB、Oracle、DB2、PostgreSQL、SQLServer 等多种数据库
22-
- 支持参数自动校验以及自定义参数校验
23-
- 支持分页查询以及自定义分页查询
24-
- 支持XML中调用java方法
25-
- 支持执行多条sql语句
26-
- 支持多数据源
27-
- 支持主键自动生成,可自定义配置主键生成策略
28-
- 自动热更新
29-
- 支持缓存
30-
- ~~支持单表自动映射CRUD~~
31-
- ~~支持调用存储过程~~
20+
- 支持MySQL、MariaDB、Oracle、DB2、PostgreSQL、SQLServer 等多种数据库
21+
- 支持非关系型数据库Redis、Mongodb
22+
- 支持分页查询以及自定义分页查询
23+
- 支持多数据源配置
24+
- 支持SQL缓存,以及自定义SQL缓存
25+
- 支持自定义JSON结果、自定义分页结果
26+
- SQL支持拼接,占位符,判断等语法
27+
- 基于[magic-script](https://gitee.com/ssssssss-team/magic-script)脚本引擎,动态编译,无需重启,实时发布
28+
- 支持脚本代码自动提示、错误提示
29+
- 支持在线调试脚本引擎
30+
- 支持自定义工具类、自定义模块包
3231

3332
# 快速开始
3433

@@ -38,59 +37,37 @@
3837
<dependency>
3938
<groupId>org.ssssssss</groupId>
4039
<artifactId>magic-api-spring-boot-starter</artifactId>
41-
<version>0.1.1</version>
40+
<version>0.2.0</version>
4241
</dependency>
4342
```
4443
## 修改application.properties
4544

4645
```properties
4746
server.port=9999
48-
#配置magic-api的xml所在位置
49-
magic-api.xml-locations: classpath*:magic-api/**/*.xml
47+
#配置web页面入口
48+
magic.web=/magic/web
5049
#以下配置需跟实际情况修改
5150
spring.datasource.url=jdbc:mysql://localhost/test
5251
spring.datasource.username=root
5352
spring.datasource.password=123456789
5453
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
5554
```
5655

57-
## 创建XML
56+
## 执行建表语句
5857

59-
`src/main/resources/magic-api/`下建立`user.xml`文件
60-
```xml
61-
<?xml version="1.0" encoding="utf-8" ?>
62-
<magic request-mapping="/user"
63-
xmlns="http://ssssssss.org/schema"
64-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
65-
xsi:schemaLocation="http://ssssssss.org/schema http://ssssssss.org/schema/magic-0.1.xsd">
66-
<!-- 访问地址/user/list,访问方法get,并开启分页 -->
67-
<select-list request-mapping="/list" request-method="get" page="true">
68-
select username,password from sys_user
69-
</select-list>
70-
</magic>
71-
```
58+
执行`magic-api`仓库下[db/magic-api.sql](https://gitee.com/ssssssss-team/magic-api/blob/master/db/magic_api.sql)建表语句
7259

73-
## 测试
74-
访问`http://localhost:9999/user/list`
60+
## 在线编辑
61+
访问`http://localhost:9999/magic/web`进行操作
7562

76-
结果如下:
77-
```json
78-
{
79-
"code": 1,
80-
"message": "success",
81-
"data": {
82-
"total": 2,
83-
"list": [{
84-
"password": "123456",
85-
"username": "admin"
86-
}, {
87-
"password": "1234567",
88-
"username": "1234567"
89-
}]
90-
},
91-
"timestamp": 1588586539249
92-
}
93-
```
63+
# 项目截图
64+
65+
## 整体截图
66+
![整体截图](https://images.gitee.com/uploads/images/2020/0704/222426_953f813c_297689.png "full.png")
67+
## 代码提示
68+
![代码提示](https://images.gitee.com/uploads/images/2020/0704/222708_97f1e1bb_297689.gif "completion.gif")
69+
## DEBUG
70+
![DEBUG](https://images.gitee.com/uploads/images/2020/0704/222725_524c2027_297689.gif "debug.gif")
9471

9572
# 其它开源项目
9673
- [magic-api](https://gitee.com/ssssssss-team/magic-api)

0 commit comments

Comments
 (0)