接口快速开发框架 magic-api 2.x初体验

最新推荐文章于 2025-03-06 12:03:41 发布

enjoy编程

最新推荐文章于 2025-03-06 12:03:41 发布

阅读量7.6k

点赞数 2

分类专栏：微服务架构文章标签： spring boot 接口快速开发框架 magic-api 填坑低代码开发

本文链接：https://blog.csdn.net/penriver/article/details/123179484

版权

微服务架构专栏收录该内容

20 篇文章

订阅专栏

什么是magic-api?

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

详细介绍参见：magic-api 指南

目前最新版本是：2.0.0-beta.1，但由于2.x重构了底层存储逻辑，1.x并不能直接升级至2.x版本【升级时需要将1.x中的所有接口、函数、数据源先导出，然后再导入到2.x中】

初体验

将example导入idea

clone项目 git clone https://gitee.com/ssssssss-team/magic-api-example.git
导入到idea中
修改配置resources/application.yml
在数据库中创建表：magic_api_file_v2，test_data 并插入初始化数据
启动MagicAPIExampleApplication 这个springboot应用
通过WEB 浏览器访问： http://localhost:9999/magic/web/index.html

application.yml配置

server:
  port: 9999
  # 配置静态资源启用 gzip 压缩
  compression:
    enabled: true
    min-response-size: 128
# 配置主数据源
spring:
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8
  datasource:
    url: jdbc:mysql://172.25.21.188:3306/test?allowMultiQueries=true&useSSL=false&useUnicode=true&characterEncoding=UTF8&serverTimezone=Asia/Shanghai
    username: videoweb
    password: suntek
magic-api:
  web: /magic/web
  resource:
    type: database  # 配置接口存储方式，这里选择存在数据库中
    table-name: magic_api_file_v2  # 数据库中的表名
    prefix: /magic-api  # 前缀
  swagger:
    version: 1.0
    description: MagicAPI 接口信息
    title: MagicAPI Swagger Docs
    name: MagicAPI 接口
    location: /v2/api-docs/magic-api/swagger2.json

建表及初始化数据SQL语句

以下语句在上面配置的MySQL数据源中执行。

CREATE TABLE `magic_api_file_v2` (
  `file_path` varchar(512) NOT NULL,
  `file_content` mediumtext,
  PRIMARY KEY (`file_path`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4

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');

API管理界面

API管理界面如下：
在这里插入图片描述

配置接口API

查询接口配置

创建分组，指定分组名称及路径
创建接口，指定请示方法、接口名称、接口路径、请示参数信息（设定方法详见：请示参数获取）、接口描述。
配置完成后，可点击右上角的运行按钮进行测试

在这里插入图片描述

增加接口配置

根据不同的业务场景要求，选用以下写法：

return db.table('test_data').insert({ id : 4, name : 'admin'})
return db.table('test_data').primary('id').save({ id : 4, name : 'admin'})

更新接口配置

return db.table('test_data').primary('id').update({ id: 4, name : '张三峰'})

删除接口配置

return db.table('test_data').primary('id').where().eq('id',4).delete()

查看swagger信息

访问地址：http://localhost:9999/swagger-ui.html
在这里插入图片描述

填坑记录

`Failed to start bean 'documentationPluginsBootstrapper'； nested exception is java.lang.NullPointerEx`

在magic-api快速开始文档中，要求添加：spring-boot-starter-parent的版本是2.6.4，但example中使用的Swagger版本是2.9.2，由于springboot版本太高，缺少swagger运行所需要的环境【具体缺少什么未知】，所以将springboot的版本下降到2.4.5 即可正常启动。

具体报错信息如下：

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181) ~[spring-context-5.3.16.jar:5.3.16]
	at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54) ~[spring-context-5.3.16.jar:5.3.16]
......
......
Caused by: java.lang.NullPointerException: null
	at springfox.documentation.spi.service.contexts.Orderings$8.compare(Orderings.java:112) ~[springfox-spi-2.9.2.jar:null]
	at springfox.documentation.spi.service.contexts.Orderings$8.compare(Orderings.java:109) ~[springfox-spi-2.9.2.jar:null]
	at com.google.common.collect.ComparatorOrdering.compare(ComparatorOrdering.java:37) ~[guava-20.0.jar:na]
	at java.util.TimSort.countRunAndMakeAscending(TimSort.java:356) ~[na:1.8.0_131]