Skip to content

社区版

crabc-apiPingApi开源版的接口开发平台,SQL2API开发管理系统,采用单体架构集成SpringBoot、JWT、Mybatis等框架实现。 支持(mysql、oracle、postgresql、sqlserver、达梦、TiDB)等数据源,界面可视化编写好SQL即可快速生成一个接口对外提供服务。支持Mybatis中if等标签语法,减少通用接口的SQL编写,可通过Maven的方式在项目中接入crabc,让项目立即具备接口在线开发和管理的能力,让开发人员专注更复杂的业务逻辑实现。

功能特点

  • 接口开发:可视化编写SQL快速的对外发布成API接口,支持Mybatis标签语法,实现动态SQL和动态标签
  • 在线测试:可以在线测试接口查看结果
  • 数据源管理:动态加载数据库,支持多种数据库。
  • 个人中心:用户管理,密码修改。
  • 调用凭证:AppKey认证、签名认证
  • 接口管理:查看开发中和已发布的API接口,可进行上下线管理,编辑、删除等
  • 接口日志:查看发布的接口被调用日志列表和请求详情。

项目结构

cn.crabc    
├── crabc-boot               // 业务模块
│     └── crabc-admin        // 后台管理
│           └── static       // 前端静态页面 [9377]
│     └── crabc-datasource   // 数据源加载模块
│     └── crabc-api          // API调用执行模块
│     └── crabc-spi          // 插件定义模块
├── db                       // SQL脚本
├──pom.xml                   // 依赖

开源地址

github: https://github.com/pingapi/crabc-api
gitee: https://gitee.com/linebyte/crabc

Maven集成

<dependency>
    <groupId>cn.crabc</groupId>
    <artifactId>crabc-spring-boot-starter</artifactId>
    <version>3.5.0</version>
</dependency>

在程序启动类中添加下面注解

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})

集成Demo参考: crabc-spring-boot-starter-demo

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