# 超级数据-api

**Repository Path**: warrior-james/super-data-api-master

## Basic Information

- **Project Name**: 超级数据-api
- **Description**: 通过页面配置生成在线接口。（目前可针对Mysql和Elasticsearch数据源的表生成增删改查导出等接口，针对Mysql数据源可以配置多表关联接口）
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 18
- **Forks**: 0
- **Created**: 2022-05-16
- **Last Updated**: 2025-10-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: ElasticSearch

## README

# super-data-api

### 项目说明
  通过页面配置动态生成在线接口。

### 项目特点
能够快速动态生成CRUD接口，减少重复工作
可以在项目中扩展编写复自定义接口
支持MySQL、ElasticSearch数据库
Mysql支持关联查询
支持报表导出接口
支持自定义sql生成接口

#### 安装教程
通过git下载源码
执行db下initDataBase和v1.0.sql文件，初始化数据
修改application.yml，更新MySQL账号和密码、数据库名称
Linux环境运行sh文件下 ./run_super-data-api.sh start 脚本命令
http://localhost:1001/home.html 打开主页面
#### 软件架构
JDK1.8、Maven、IDEA、SpringBoot 2.2.4.RELEASE、ElasticSearch、Mybatis-Plus、Vue等

#### 使用说明
1.新建数据源

![img_1.png](src/main/resources/pic/img_1.png)

2.新增接口

    2.1 Insert类型接口
    2.1.1 Mysql数据源要先选择数据源，然后选择数据库，再选择想插入的表即可，接口配置中字段名称是数据库表字段名称，
          参数名称是请求的参数名称，参数类型是必须，分url传参和body传参

![img_2.png](src/main/resources/pic/img_2.png)

    2.2.2 Es数据源只选择数据源和表即可，接口配置中信息同mysql数据源类型接口
![img_3.png](src/main/resources/pic/img_3.png)

    2.2 Delete类型接口
    2.2.1 Delete类型接口就是根据条件删除指定表的数据，其中mysql要先选中数据库，接口配置中多了必选的条件类型字段
![img_4.png](src/main/resources/pic/img_4.png)
 
    2.3 Update类型接口
    2.2.1 Update类型接口就是更新数据库，其中mysql要选中数据库，接口配置中多了必选的是否更新参数字段，意思是是
          否是待更新的表字段
    
![img_5.png](src/main/resources/pic/img_5.png)

    2.4 Select类型接口
    2.4.1 Es数据源
    ElasticSearch数据源类型不支持关联查询，查询参数可以配置成url传参或者body传参。可以选择是否必传参数，
    和查询的条件类型。也可以配置返回参数名称，设置是否排序字段和顺序或者倒叙。若是导出接口最少配置一列导出数据。

![img_6.png](src/main/resources/pic/img_6.png)

    2.4.2 Mysql数据源
    Mysql数据源类型在ElasticSearch功能基础上添加多表关联配置，选择好Mysql数据源可以通过接口获取获取下面的
    表和表的字段信息，然后通过页面配置其关联关系和接口相关参数。

![img_7.png](src/main/resources/pic/img_7.png)

    2.4.3 自定义sql接口配置

![img_8.png](src/main/resources/pic/img_8.png)

3.查看、编辑、删除、调试接口

    3.1查看接口详情
![img_9.png](src/main/resources/pic/img_9.png)

    3.2编辑接口
![img_10.png](src/main/resources/pic/img_10.png)

    3.3调试调用接口
![img_11.png](src/main/resources/pic/img_11.png)