Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

English translation of README.md #104

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

English translation of README.md #104

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1b6e3c
translate to English
VRDate Jan 16, 2023
72dd4cb
fix English translation
VRDate Jan 17, 2023
a95c29a
fix links
VRDate Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 61 additions & 50 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,84 +2,95 @@
<img src="https://www.ssssssss.org/images/logo-magic-api.png" width="256">
</p>
<p align="center">
<a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html"><img src="https://img.shields.io/badge/JDK-1.8+-green.svg" /></a>
<a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html"><img src="https://img.shields.io/badge/ JDK-1.8+-green.svg" /></a>
<a href="https://search.maven.org/search?q=g:org.ssssssss%20AND%20a:magic-api">
<img alt="maven" src="https://img.shields.io/maven-central/v/org.ssssssss/magic-api.svg?style=flat-square">
</a>
<a target="_blank" href="https://www.ssssssss.org"><img src="https://img.shields.io/badge/Docs-latest-blue.svg"/></a>
<a target="_blank" href="https://github.com/ssssssss-team/magic-api/releases"><img src="https://img.shields.io/github/v/release/ssssssss-team/magic-api?logo=github"></a>
<a target="_blank" href='https://gitee.com/ssssssss-team/magic-api'><img src="https://gitee.com/ssssssss-team/magic-api/badge/star.svg?theme=white" /></a>
<a target="_blank" href='https://github.com/ssssssss-team/magic-api'><img src="https://img.shields.io/github/stars/ssssssss-team/magic-api.svg?style=social"/></a>
<a target="_blank" href="https://www.ssssssss.org"><img src="https://img.shields.io/badge/Docs-latest-blue.svg"/></ a>
<a target="_blank" href="https://github.com/ssssssss-team/magic-api/releases"><img src="https://img.shields.io/github/v/release/ ssssssss-team/magic-api?logo=github"></a>
<a target="_blank" href='https://gitee.com/ssssssss-team/magic-api'><img src="https://gitee.com/ssssssss-team/magic-api/badge/ star.svg?theme=white" /></a>
<a target="_blank" href='https://github.com/ssssssss-team/magic-api'><img src="https://img.shields.io/github/stars/ssssssss-team/ magic-api.svg?style=social"/></a>
<a target="_blank" href="LICENSE"><img src="https://img.shields.io/:license-MIT-blue.svg"></a>
<a target="_blank" href=https://qm.qq.com/cgi-bin/qm/qr?k=Q6dLmVS8cHwoaaP18A3tteK_o0244e6B&jump_from=webapi"><img src="https://img.shields.io/badge/QQ群-739235910-blue"></a>
<a target="_blank" href=https://qm.qq.com/cgi-bin/qm/qr?k=Q6dLmVS8cHwoaaP18A3tteK_o0244e6B&jump_from=webapi"><img src="https://img.shields.io/badge/QQgroup-739235910-blue"></a>
</p>

[特性](#特性) | [快速开始](#快速开始) | [文档/演示](#文档演示) | [示例项目](#示例项目) | <a target="_blank" href="http://ssssssss.org/changelog.html">更新日志</a> | [项目截图](#项目截图)
<a target="_blank" href="http://ssssssss.org/changelog.html">Changelog</a>

# 简介
# Introduction

magic-api 是一个基于Java的接口快速开发框架，编写接口将通过magic-api提供的UI界面完成，自动映射为HTTP接口，无需定义Controller、Service、Dao、Mapper、XML、VO等Java对象即可完成常见的HTTP API接口开发
magic-api is a Java-based interface rapid development framework, the writing interface will be completed through the UI interface provided by magic-api, automatically mapped to HTTP interface, no need to define Java objects such as Controller, Service, Dao, Mapper, XML, VO Complete common HTTP API interface development


【已有上千家中小型公司使用，上万名开发者用于接口配置开发。上百名开发者参与提交了功能建议，接近20多名贡献者参与。已被gitee长期推荐。从首个版本开始不断优化升级，目前版本稳定，开发者交流群活跃。参与交流QQ群③739235910】
[It has been used by thousands of small and medium-sized companies, and tens of thousands of developers have used it for interface configuration development. Hundreds of developers participated in submitting feature suggestions, and nearly 20 contributors participated. It has been recommended by gitee for a long time. Since the first version, it has been continuously optimized and upgraded. The current version is stable and the developer exchange group is active. Participate in the communication QQ group ③739235910]

# 特性
- 支持MySQL、MariaDB、Oracle、DB2、PostgreSQL、SQLServer 等支持jdbc规范的数据库
- 支持非关系型数据库Redis、Mongodb
- 支持集群部署、接口自动同步。
- 支持分页查询以及自定义分页查询
- 支持多数据源配置，支持在线配置数据源
- 支持SQL缓存，以及自定义SQL缓存
- 支持自定义JSON结果、自定义分页结果
- 支持对接口权限配置、拦截器等功能
- 支持运行时动态修改数据源
- 支持Swagger接口文档生成
- 基于[magic-script](https://gitee.com/ssssssss-team/magic-script)脚本引擎，动态编译，无需重启，实时发布
- 支持Linq式查询，关联、转换更简单
- 支持数据库事务、SQL支持拼接，占位符，判断等语法
- 支持文件上传、下载、输出图片
- 支持脚本历史版本对比与恢复
- 支持脚本代码自动提示、参数提示、悬浮提示、错误提示
- 支持导入Spring中的Bean、Java中的类
- 支持在线调试
- 支持自定义工具类、自定义模块包、自定义类型扩展、自定义方言、自定义列名转换等自定义操作
# Features
- Support MySQL, MariaDB, Oracle, DB2, PostgreSQL, SQLServer and other databases that support jdbc specification
- Support non-relational database Redis, Mongodb
- Supports cluster deployment and automatic interface synchronization.
- Support paging query and custom paging query
- Support multiple data source configuration, support online configuration data source
- Support SQL cache, and custom SQL cache
- Support custom JSON results, custom pagination results
- Support for interface permission configuration, interceptor and other functions
- Support dynamic modification of data sources at runtime
- Support Swagger interface document generation
- Based on [magic-script](https://gitee.com/ssssssss-team/magic-script) script engine, dynamic compilation, no need to restart, real-time release
- Support Linq-style query, making association and conversion easier
- Support database transactions, SQL support splicing, placeholders, judgment and other syntax
- Support file upload, download, output picture
- Support script historical version comparison and restoration
- Support script code automatic prompt, parameter prompt, floating prompt, error prompt
- Support importing Beans in Spring and classes in Java
- Support online debugging
- Supports custom operations such as custom tool classes, custom module packages, custom type extensions, custom dialects, and custom column name conversions

# 快速开始
# Quick Start

## maven引入
## Maven Import
```xml
<!-- 以spring-boot-starter的方式引用 -->
<!-- Referenced by spring-boot-starter -->
<dependency>
<groupId>org.ssssssss</groupId>
<artifactId>magic-api-spring-boot-starter</artifactId>
<version>2.0.1</version>
<artifactId>magic-api-spring-boot-starter</artifactId>
<version>2.0.1</version>
</dependency>
```
## 修改application.properties
## Modify application.properties

```properties
server.port=9999
#配置web页面入口
#Configure web page entry
magic-api.web=/magic/web
#配置文件存储位置。当以classpath开头时，为只读模式
#Configuration file storage location. When starting with classpath, it is read-only mode
magic-api.resource.location=/data/magic-api
```

## 在线编辑
访问`http://localhost:9999/magic/web`进行操作
## Online Editing
Visit `http://localhost:9999/magic/web` to operate

# 文档/演示
# Documentation/Demo

- 文档地址：[https://ssssssss.org](https://ssssssss.org)
- 在线演示：[https://magic-api.ssssssss.org](https://magic-api.ssssssss.org)
- Document address: [https://ssssssss.org](https://ssssssss.org)
- Online demo: [https://magic-api.ssssssss.org](https://magic-api.ssssssss.org)

# 示例项目
# Example Project

- [magic-api-example](https://gitee.com/ssssssss-team/magic-api-example)

# 项目截图
| ![整体截图](https://images.gitee.com/uploads/images/2021/0711/105714_c1cacf2c_297689.png "整体截图") | ![代码提示](https://images.gitee.com/uploads/images/2021/0711/110448_11b6626b_297689.gif "代码提示") |
|---|---|
| ![DEBUG](https://images.gitee.com/uploads/images/2021/0711/110515_755f178a_297689.gif "DEBUG") | ![参数提示](https://images.gitee.com/uploads/images/2021/0711/110322_9dd6d149_297689.gif "参数提示") |
| ![远程推送](https://images.gitee.com/uploads/images/2021/0711/105803_b53e0d7e_297689.png "远程推送") | ![历史记录](https://images.gitee.com/uploads/images/2021/0711/105910_f2440ea4_297689.png "历史记录") |
| ![数据源](https://images.gitee.com/uploads/images/2021/0711/105846_7ec51a50_297689.png "数据源") | ![全局搜索](https://images.gitee.com/uploads/images/2021/0711/105823_ac18ada7_297689.png "全局搜索") |
# Project Screenshots
- Overall Screenshot<br/>
![Overall Screenshot](https://images.gitee.com/uploads/images/2021/0711/105714_c1cacf2c_297689.png "Overall Screenshot")
- Code Tips<br/>
![Code Tips](https://images.gitee.com/uploads/images/2021/0711/110448_11b6626b_297689.gif "Code Tips")
- DEBUG<br/>
![DEBUG](https://images.gitee.com/uploads/images/2021/0711/110515_755f178a_297689.gif "DEBUG")
- Parameter Prompt<br/>
![Parameter Prompt](https://images.gitee.com/uploads/images/2021/0711/110322_9dd6d149_297689.gif "Parameter Prompt")
- Remote Push<br/>
![Remote Push](https://images.gitee.com/uploads/images/2021/0711/105803_b53e0d7e_297689.png "Remote Push")
- History<br/>
![History](https://images.gitee.com/uploads/images/2021/0711/105910_f2440ea4_297689.png "History")
- Data Source<br/>
![Data Source](https://images.gitee.com/uploads/images/2021/0711/105846_7ec51a50_297689.png "Data Source")
- Global Search<br/>
![Global Search](https://images.gitee.com/uploads/images/2021/0711/105823_ac18ada7_297689.png "Global Search")