# 快速开始

​ 我们将通过一个简单的demo来阐述magic-api的功能。假设您已经:

  • 拥有Java开发环境及相关IDE。
  • 拥有Mysql环境。
  • 熟悉Spring Boot。
  • 熟悉Maven。

​ 创建一张测试表TestData,结构如下

id name
1 magicApi
2 xiaoDong

​ DDL如下:

create table test_data
(
    id   bigint       not null
        primary key,
    name varchar(100) null
);
INSERT INTO test_data (id, name) VALUES (1, 'magicApi');
INSERT INTO test_data (id, name) VALUES (2, 'xiaoDong');
1
2
3
4
5
6
7
8

# 初始化工程

​ 创建一个空的 Spring Boot 工程, 以mysql作为默认数据库进行演示。

# 添加依赖

引入 Spring Boot Starter 父工程:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>spring-boot-latest-version</version>
    <relativePath/>
</parent>
1
2
3
4
5
6

​ 引入magic-api-spring-boot-starter依赖。

<dependency>
    <groupId>org.ssssssss</groupId>
    <artifactId>magic-api-spring-boot-starter</artifactId>
    <version>magic-api-lastest-version</version>
</dependency>
1
2
3
4
5

​ 引入spring-boot-starter,spring-boot-starter-web, spring-boot-starter-test, mysql依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.27</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 配置

​ application.yml

server:
  port: 9999
magic-api:
  #配置web页面入口
  web: /magic/web
  resource:
  	#配置文件存储位置。当以classpath开头时,为只读模式
    location: F:/data/magic-api

spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/magic-api-test?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8
    username: root
    password: test
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 访问api管理界面

启动项目之后,访问http://localhost:9999/magic/web 即可看到Web页面

# 三分钟写出查询接口

1. 创建分组

点击创建分组按钮后,输入分组信息,点击创建。

2. 新建接口

右键分组,点击新建接口。

在编辑器输入内容后,填写接口名称和及其路径。

var sql = """
select * from test_data
"""

return db.select(sql)
1
2
3
4
5

​ ctrl+s保存后,即可访问接口。

3.访问接口

> curl http://localhost:9999/test/test

{
    "code": 1,
    "message": "success",
    "data": [
        {
            "id": 1,
            "name": "magicApi"
        },
        {
            "id": 2,
            "name": "xiaoDong"
        }
    ],
    "timestamp": 1638192442535,
    "executeTime": 9
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

​ 也可以通过web界面执行。

# 小结

​ 通过以上几个步骤,我们就实现了一个简单的查询功能。省去了ControllerServiceDaoMapperXMLVO等模板代码的工作量。

​ 想要了解更多magic-api的功能?请接着往下看。

上次更新: 12/28/2021, 2:52:32 AM
赞助商