# crabc-api

**Repository Path**: linebyte/crabc

## Basic Information

- **Project Name**: crabc-api
- **Description**: crabc-api是一款低代码API接口开发平台，企业级接口管理、数据服务平台。数据库转API，实现动态数据源、动态SQL和标签，在线可视化编写SQL快速发布API接口，支持接口管理、代理转发、鉴权、限流、熔断和监控告警等一站式API数据服务。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: dev
- **Homepage**: https://www.crabc.cn
- **GVP Project**: No

## Statistics

- **Stars**: 528
- **Forks**: 169
- **Created**: 2023-03-01
- **Last Updated**: 2025-06-24

## Categories & Tags

**Categories**: lowcode

**Tags**: 低代码, api网关, 接口管理, 零代码, 数据服务

## README


# 由来
crabc由create + abc 组合而来，意在为项目系统构建的通用的接口底座。

# 介绍
**crabc** 是低代码接口开发平台，企业数据服务平台，深度整合SpringBoot和Mybatis实现动态数据源和动态SQL。
支持接入（mysql、oracle、postgresql、sqlserver、达梦、TiDB、es和mongodb）等SQL或/NoSQL数据源，
在线可视化编写SQL后即可快速生成接口对外提供服务，接口一键上下线。减少通用接口的SQL编写，让开发人员专注更复杂的业务逻辑实现。
支持Mybatis中if等标签语法、数据脱敏、数据转换等功能，集成微服务网关支持接入第三方接口、权限认证、限流、缓存、告警监控和统一日志等一站式API数据服务。

![img.png](doc/home.png)
## 功能
- **工作台**：可视化编写SQL快速的对外发布成API接口,支持多SQL同时执行、Mybatis标签语法，实现动态SQL和动态标签
- **数据源管理**：动态加载数据库，支持多种SQL/NoSQL数据库。
- **应用列表**：Code认证、签名认证的应用创建管理以及对API调用在线授权。
- **接口列表**：查看开发中和已发布的API接口，可进行上下线管理，编辑升级等
- **接口日志**：查看发布的接口被调用日志列表和请求详情。

## 模块
~~~
cn.crabc    
├── crabc-boot               // 业务模块
│     └── crabc-admin        // 启动模块
│     └── crabc-core        // 基础模块
│           └── static       // 前端静态页面 [9377]
│     └── crabc-datasource   // 数据源加载模块
│     └── crabc-spi          // 插件定义模块
├── crabc-spring-boot-starter // 第三方项目maven集成依赖包
├── db                       // SQL脚本
├──pom.xml                   // 依赖
~~~ 

## 版本说明
dev分支框架SpringBoot已升级至3.5，jdk需17及以上版本 \
2.x分支框架SpringBoot还是2.x

## 运行启动
```
1、先执行db/dml.sql脚本，创建库表和初始化数据
2、在编辑工具中运行启动 crabc-admin/ AdminApplication.java
```
访问地址：http://127.0.0.1:9377 \
账号密码：admin/admin123

## 官网
官网：https://www.crabc.cn/ \
使用指南：https://www.crabc.cn/introduction/ \
github：https://github.com/pingapi/crabc-api

## 商用授权
已申请软件著作，开源版仅供个人学习使用 \
企业版功能更强大，商用请加群联系\

## 源码地址
github: https://github.com/pingapi/crabc-api \
gitee: https://gitee.com/linebyte/crabc

## Maven集成crabc-api

```
<dependency>
    <groupId>cn.crabc</groupId>
    <artifactId>crabc-spring-boot-starter</artifactId>
    <version>3.5.0</version>
</dependency>
```
在程序启动类中添加下面注解
```
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
```
集成Demo参考: <a href="https://gitee.com/linebyte/crabc-spring-boot-starter-demo" style="text-decoration: none;" target="_blank">crabc-spring-boot-starter-demo</a>

## Docker启动
先执行db/dml.sql脚本，创建库表和初始化数据，建议mysql 8.0+版本
```
docker pull crabc/crabc-admin:latest
docker run -p 9377:9377 -e DB_URL='jdbc:mysql://localhost:3306/crabc' -e DB_USER=root -e DB_PWD=root -d --name crabc-admin crabc/crabc-admin:latest
```
访问地址：http://127.0.0.1:9377
账号密码：admin/admin123

## Windows桌面运行
先执行db/dml.sql脚本，创建库表和初始化数据，建议mysql 8.0+版本
```
java -jar crabc-admin.jar --spring.datasource.url=jdbc:mysql://127.0.0.1:3306/crabc --spring.datasource.username=root --spring.datasource.password=root 
```

## 企业版和开源版对比
| 功能     |  社区版  |  企业版  |
|--------|------------------------------| --------------------------|
| 架构设计   | 单体                           | 微服务                    |
| 接口创建模式 | SQL脚本                        | SQL脚本、图表、代理转发     |
| 动态标签   | 支持                           | 支持                      |
| 动态路由   | 不支持                          | 支持                      |
| 数据库    | SQL：mysql/oracle/postgresql/sqlserver <br>TiDB/OpenGauss/Doris |SQL：mysql/oracle/postgresql/sqlserver/tidb<br>/opengauss/doris/oceanbase/dm/gbase <br> NoSQL：es/mongodb <br> TSDB: TDengine      |
| 认证方式   | 无/Code认证/签名认证              | 无/Code认证/签名认证         |
| SQL类型  | 查询SQL                        | 查询/插入/更新/删除等SQL     |
| 结果类型   | json                         | json                 |
| 接口日志   | 支持                           | 支持                       |
| 数据转换   | 不支持                          | 支持                       |
| 嵌套结构   | 不支持                          | 支持                       |
| 接口市场   | 不支持                          | 支持                       |
| 申请审批   | 不支持                          | 支持                       |
| 接口授权   | 不支持                          | 支持                       |
| 系统权限   | 不支持                          | 支持                       |
| 用户管理   | 不支持                          | 支持                         |
| 数据脱敏   | 不支持                          | 支持                         |
| 版本管理   | 不支持                          | 支持      
| 接口缓存   | 不支持                          | 支持                         |
| 限流熔断   | 不支持                           | 限流和熔断                     |
| IP黑白名单 | 不支持                          | 支持                         |
| 监控报表   | 支持                           | 支持                         |
| 集群模式   | 不支持                          | 支持                         |
## 效果截图
### 接口开发
![img.png](doc/sql.png)
#### 接口属性
![img.png](doc/detail.png)
#### 请求参数
![img.png](doc/param.png)
#### 在线预览
![img_2.png](doc/img_test.png)
#### 接口列表 
![img.png](doc/api.png) 
#### 数据库类型
![img.png](doc/db.png)
### 限流熔断
![img.png](doc/flow.png)

## 产品使用登记
以下为部分接入crabc-api的用户 ，<a href="https://gitee.com/linebyte/crabc/issues/IA98CA" target="_blank"> 点击进行登记</a>

| 公司机构         |
|:-------------|
| 西部通信研究院      |
| 青岛巴士科技有限公司   |
| 阳光智维科技股份有限公司 |
| 一步数据科技有限公司   |
| 像素云图科技有限公司   |
| 前景科技有限公司     |
| 方寸图信息有限公司    |
| 鹭栖技术信息公司     |
| 循脉医疗科技有限公司   |
| 云上贵州大数据有限公司  |

## 交流群
**进群前请先点【Star】谢谢**

QQ群：748993036

商用咨询加微信 (请备注crabc)

![img.png](doc/img.png)