magic-api: A Java‑Based Rapid API Development Framework – Features and Quick Start Guide

Introduction

magic-api is a Java‑based rapid API development framework. By writing interfaces through the magic‑api UI, the system automatically maps them to HTTP endpoints, eliminating the need to define Controllers, Services, DAOs, Mappers, XML, or VO classes for common HTTP API development.

Features

Supports MySQL, MariaDB, Oracle, DB2, PostgreSQL, SQLServer and other JDBC‑compliant databases.

Supports NoSQL databases such as Redis and MongoDB.

Cluster deployment and automatic interface synchronization.

Pagination queries and custom pagination.

Multiple data source configuration with online data source management.

SQL caching and custom SQL cache implementations.

Custom JSON results and custom pagination results.

Interface permission configuration, interceptors, and related features.

Runtime dynamic data source switching.

Swagger API documentation generation.

Based on the magic‑script engine, scripts are compiled dynamically without restart, enabling real‑time publishing.

Linq‑style queries for simpler association and transformation.

Database transaction support, SQL concatenation, placeholders, conditional syntax, etc.

File upload, download, and image output.

Script version history comparison and restoration.

Script code auto‑completion, parameter hints, hover tips, and error prompts.

Import of Spring beans and Java classes.

Online debugging.

Custom tool classes, modules, type extensions, dialects, column name conversions, and other extensibility options.

Quick Start

Maven Dependency

<!-- Include as a spring‑boot‑starter -->
<dependency>
  <groupId>org.ssssssss</groupId>
  <artifactId>magic-api-spring-boot-starter</artifactId>
  <version>1.7.1</version>
</dependency>

application.properties Configuration

server.port=9999
# Web UI entry point
magic-api.web=/magic/web
# Resource location (classpath prefix means read‑only mode)
magic-api.resource.location=/data/magic-api

Online Editing

Access http://localhost:9999/magic/web to use the UI.

Documentation / Demo

Documentation: https://ssssssss.org

Online demo: https://magic-api.ssssssss.org

Example Project

https://gitee.com/ssssssss-team/magic-api-example

Project Screenshots

(Images omitted for brevity)

Recommended Resources

Mainstream Java Advanced Technology (Learning Materials)

Java Interview Question Treasury

Join the Spring Technology Development Community

Support Us

Click “Watch” and add a “Star” on the public account to ensure new articles appear promptly in your subscription list.