# Viewer

**Repository Path**: ThoughtSet/Viewer

## Basic Information

- **Project Name**: Viewer
- **Description**: Viewer 是一款基于SpringBoot构建的API敏捷开发平台，突破传统编码范式，提供从SQL到API的一站式数据服务能力。通过可视化SQL工作台，开发者无需编写Java代码即可发布标准RESTful接口，针对查询、大屏场景提供快速迭代方案，助力企业快速构建高性能数据决策系统。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2025-03-10
- **Last Updated**: 2025-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 低代码, MyBatis, 快速开发平台

## README

# Viewer - 零代码API开发平台

![License](https://img.shields.io/hexpm/l/plug.svg)
![SpringBoot](https://img.shields.io/badge/SpringBoot-3.x-green.svg)
![MySQL](https://img.shields.io/badge/MySQL-5.7%2B-orange)
<a target="_blank" href="https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html">
   <img src="https://img.shields.io/badge/JDK-17-green.svg" alt="jdk-17" />
</a>
## 🚀 项目简介
Viewer 是一款基于SpringBoot构建的API敏捷开发平台，突破传统编码范式，提供从SQL到API的一站式数据服务能力。通过可视化SQL工作台，开发者无需编写Java代码即可发布标准RESTful接口，针对查询、大屏场景提供快速迭代方案，助力企业快速构建高性能数据决策系统。

## ✨ 核心特性

- **零代码开发**：告别Controller/Service/Dao编写
- **MyBatis SQL支持**：直接使用熟悉的SQL语法开发接口
- **可视化操作**：通过Web界面完成API开发全流程
- **自动生成**：根据SQL自动生成Swagger文档和参数校验
- **多数据源**：支持MySQL/Oracle/PostgreSQL等主流数据库，在一次请求中可跨数据源查询
- **高性能**：基于SpringBoot的轻量级架构
- **实时生效**：支持动态创建、修改API；动态创建、修改数据源。热部署全程无感。

## 🚀 5分钟快速体验
### 1. 下载运行
```bash
# 下载最新JAR包（约15MB）

#Window启动命令：
java -jar viewer-apis-service.jar

#Linux下后台进程启动命令：
nohup java -jar viewer-apis-service.jar >catalina.out 2>&1 &

#关掉项目：
ps -ef|grep java
kill 进程号 
```

## 📖 使用指南

### 创建第一个API
1. 访问 `http://localhost:11791` 登录管理界面
2. 在"SQL工作台"编写MyBatis风格SQL：
   ```sql
   SELECT * FROM users 
   WHERE username = #{username} 
   AND status = #{status}
   ```
3. 设置API路径（如`/api/v1/users`）
4. 点击"生成API"即可通过Swagger测试

## 📌 示例展示

![API生成界面截图](docs/screenshots/sql-editor.png)

## ⚙️ 生产环境配置
创建 `application.yml` 文件：
```yaml
server:
  port: 8080
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_db
    username: db_user
    password: db_pass
```
然后运行：
```bash
java -jar viewer-apis-service.jar --spring.config.location=application.yml
```

## 🤝 参与贡献
欢迎提交Issue和PR，贡献流程：
1. Fork本项目
2. 创建分支（`git checkout -b feature/xxx`）
3. 提交修改（`git commit -m 'feat: xxx'`）
4. 推送到远程（`git push origin feature/xxx`）
5. 创建Pull Request

## 📜 开源协议
MIT License - 自由修改和商用，但需保留原始版权声明

## ☎ 联系我们
- 欢迎大家提需求和建议[【新建issuses】](https://gitee.com/ThoughtSet/Viewer/issues/new)!（详细描述你的原始需求，我们会帮你提供一些方案，节约大家的成本）
- **内推项目** 如您觉得项目不错，可推荐到公司，建立长期稳定的商业合作，提供更专业的技术服务。

[//]: # (## 分支命名规则)

[//]: # (- `feat/*`：新功能开发)

[//]: # (- `fix/*`：问题修复)

[//]: # (- `docs/*`：文档更新)