接口快速开发利器之magic-api介绍

目录

简介

特性

简单使用

准备工作

引入pom依赖

application.yml配置 

访问页面

创建分组

新建接口

鼠标选中新建的分组

输入接口入参和返参和处理逻辑，点击右上角三角是执行此接口

访问接口

返回结果

编写sql接口

简介

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

特性

• 支持MySQL、MariaDB、Oracle、DB2、PostgreSQL、SQLServer等支持jdbc规范的数据库
• 支持非关系型数据库Redis、Mongodb、ElasticSearch
• 支持动态配置定时任务
• 支持集群部署、接口自动同步
• 支持分页查询以及自定义分页查询
• 支持多数据源配置，支持在线配置数据源
• 支持SQL缓存，以及自定义SQL缓存
• 支持自定义JSON结果、自定义分页结果
• 支持对接口权限配置、拦截器等功能
• 支持运行时动态修改数据源
• 支持Swagger接口文档生成
• 支持可插拔式的插件机制
• 支持i18n国际化
• 支持团队协作，可显示在线人数、以及他人正在编辑和浏览的接口等功能
• 基于magic-script (opens new window)脚本引擎，动态编译，无需重启，实时发布
• 支持Linq式查询，关联、转换更简单
• 支持数据库事务、SQL支持拼接，占位符，判断等语法
• 支持文件上传、下载、输出图片
• 支持脚本历史版本对比与恢复
• 支持脚本代码自动提示、参数提示、悬浮提示、错误提示
• 支持导入Spring中的Bean、Java中的类
• 支持在线调试
• 支持自定义工具类、自定义模块包、自定义类型扩展、自定义方言、自定义列名转换等自定义操作

简单使用

准备工作

一个mysql数据库，创建一张表 初始化一个springboot项目

引入pom依赖

<!-- 引入Spring Boot Starter父工程 版本注意!!! 本地只有jdk8的话需要更换此版本为3以下-->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.1.3</version>
<relativePath/>
</parent>
<!-- 引入magic-api-spring-boot-starter依赖 -->
<dependencies>
    <dependency>
        <groupId>org.ssssssss</groupId>
        <artifactId>magic-api-spring-boot-starter</artifactId>
        <version>2.1.1</version>
    </dependency>
<!-- 引入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>
</dependencies>

application.yml配置 

server:
  port: 9999
magic-api:
  #配置web页面入口
  web: /magic/web
  resource:
    #配置文件存储位置。当以classpath开头时，为只读模式
    #mac用户请改为可读写的目录
    #如果不想存到文件中，可以参考配置将接口信息存到数据库、Redis中（或自定义）
    location: D:/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

访问页面

访问127.0.0.1:9999/magic/web/index.html

创建分组

新建接口

鼠标选中新建的分组

输入接口入参和返参和处理逻辑，点击右上角三角是执行此接口

访问接口

通过点击接口页面右上角三角形可执行接口

如果是get方法可通过浏览器访问或者postman访问,其他请求类型方法可通过postman访问

返回结果

编写sql接口

执行接口

更多功能详解官网：magic-api