magic-api一个基于Java的接口快速开发框架，通过magic-api提供的UI界面完成编写接口，无需定义Controller、Service、Dao、Mapper、XML、VO等Java对象即可完成常见的HTTP API接口开发。

1、打开易优评项目

git clone 仓库，做好相应数据库的初始化及启动准备，相关操作参考，此处不赘述

2、导入magic-api相关依赖

位置：ruoyi-admin 模块的 pom.xml 文件

1
2
3
4
5

<dependency>
    <groupId>org.ssssssss</groupId>
    <artifactId>magic-api-spring-boot-starter</artifactId>
    <version>2.0.2</version>
</dependency>

3、在application.yml 中添加 magic-api 配置项

位置：ruoyi-admin/src/main/resources/application.yml文件

1
2
3
4
5
6

magic-api:
  #在线编辑代码的入口地址
  web: /magic/web
  #保存在线编辑的代码的位置
  resource:
    location: /data/magic-api

4、开放magic-api鉴权

位置：ruoyi-framework/src/main/java/com/ruoyi/framework/config/SecurityConfig.java
添加下面这行代码，开放magic-api/web下的所有URL

1
2

//访问 /magic/web/** 不拦截
.antMatchers("/magic/web/**").anonymous()

5、重启项目，访问http://192.168.73.1:8081/magic/web/index.html即可进入magic的管理页面

注意：若你在test目录下（url是magic/web）创建了接口，即可正常在线保存和调试接口。

magic-api集成到易优评完成✅

5.编写接口函数测试magic-api

接下来我们将以易优评项目管理为例，体验下使用magic-api开发接口的快感！使用magic-api开发API接口，仅需在界面中使用magic-script脚本即可。

1.查询接口

• 首先我们来写个查询接口，先创建一个分组，然后在分组中创建一个查询接口，在编辑框中输入如下脚本；

1
2
3
4
5

// 路径变量从path对象中获取
return db.table('pro_details3')
    .where()
    .eq('pro_id',path.id)
    .selectOne();

2.在底部的接口信息中进行如下配置，GET请求，请求路径为/query/{id}，请求参数放在路径变量中；

3.获取后端资源访问验证的Authorization和Cookie

4.写入请求头进行接口测试

5.运行测试

6.集成Swagger

写了那么多接口，都是在magic-api的界面中进行调试的。如果你习惯使用Swagger，magic-api也可以和Swagger进行无缝整合。

首先在pom.xml中添加Swagger相关依赖；（易优评默认集成了Swagger）

1
2
3
4
5
6
7
8
9
10
11
12
13

<dependencies>
    <!--Swagger-UI API文档生产工具-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
</dependencies>

在配置文件application.yml中添加Swagger相关配置；

1
2
3
4
5
6
7
8
9
10
11
12
13

magic-api:
  # 集成Swagger配置
  swagger-config:
    # 文档名称
    name: MagicAPI 测试接口
    # 文档标题
    title: MagicAPI Swagger Docs
    # 文档描述
    description: MagicAPI 测试接口信息
    # 文档版本号
    version: 1.0
    # 文档资源位置
    location: /v2/api-docs/magic-api/swagger2.json

访问Swagger界面即可查看我们在magic-api中写的接口了，访问地址：http://localhost:8081/swagger-ui.html