https://github.com/poboll/cai-api
Cai-API 接口开放平台
https://github.com/poboll/cai-api
apache-commons dubbo gson hutool java knife4j lombok mail maven mybatis mybatis-plus mysql payment redis spring-boot swagger
Last synced: 12 days ago
JSON representation
Cai-API 接口开放平台
- Host: GitHub
- URL: https://github.com/poboll/cai-api
- Owner: poboll
- License: mit
- Created: 2024-10-11T07:54:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-11T11:36:42.000Z (about 1 year ago)
- Last Synced: 2025-10-11T13:19:04.138Z (3 months ago)
- Topics: apache-commons, dubbo, gson, hutool, java, knife4j, lombok, mail, maven, mybatis, mybatis-plus, mysql, payment, redis, spring-boot, swagger
- Language: Java
- Homepage: https://api.caiths.com
- Size: 358 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Cai-API 接口开放平台
Cai-API 接口开放平台是一个为用户和开发者提供全面API接口调用服务的平台 🛠
## 项目介绍 🙋
**😀 作为用户您可以通过注册登录账户，获取接口调用权限，并根据自己的需求浏览和选择适合的接口。您可以在线进行接口调试，快速验证接口的功能和效果。**
**💻 作为开发者 我们提供了[客户端SDK: Cai-API-SDK](https://github.com/poboll/cai-api-sdk)， 通过[开发者凭证](https://api.caiths.com/account/center)即可将轻松集成接口到您的项目中，实现更高效的开发和调用。**
**🤝 您可以将自己的接口接入到Cai-API 接口开放平台平台上，并发布给其他用户使用。 您可以管理和各个接口，以便更好地分析和优化接口性能。**
**👌 我们还提供了[开发者在线文档](https://api-docs.caiths.com)和技术支持，帮助您快速接入和发布接口。**
**🏁 无论您是用户还是开发者，Cai-API 接口开放平台都致力于提供稳定、安全、高效的接口调用服务，帮助您实现更快速、便捷的开发和调用体验。**
## 网站导航 🧭
- [**Cai-API 后端 🏘️**](https://github.com/poboll/cai-api)
- [**Cai-API 前端 🏘**️](https://github.com/poboll/cai-api-frontend)
- **[Cai-API-SDK](https://github.com/poboll/cai-api-sdk)** 🛠
- **[Cai-API 接口开放平台 🔗](https://api.caiths.com/)**
- **[Cai-API-DOC 开发者文档 📖](https://api-docs.caiths.com)**
- **[Cai-API-SDK-demo ✔️](https://github.com/poboll/cai-api-sdk-demo/blob/main/src/main/java/com/caiths/caiapisdkdemo/controller/InvokeController.java)**
## 目录结构 📑
| 目录 | 描述 |
|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| **🏘️ [cai-api-backend](https://github.com/poboll/cai-api/cai-api-backend)** | Cai-API后端服务模块 |
| **🏘️ [cai-api-common](https://github.com/poboll/cai-api/cai-api-common)** | 公共服务模块 |
| **🕸️ [cai-api-gateway](https://github.com/poboll/cai-api/cai-api-gateway)** | 网关模块 |
| **🔗 [cai-api-interface](https://github.com/poboll/cai-api/cai-api-interface)** | 接口模块 |
| **🛠 [cai-api-sdk](https://github.com/poboll/cai-api-sdk)** | 开发者调用sdk |
| **📘 [cai-api-doc](https://api-docs.caiths.com)** | 接口在线文档 |
| **✔️ [cai-api-sdk-demo](https://github.com/poboll/cai-api-sdk-demo/blob/1.0.0/src/main/java/com/caiths/caiapisdkdemo/controller/InvokeController.java)** | SDK调用Demo |
## 项目流程 🗺️
## 快速启动 🚀
### 前端
环境要求：Node.js >= 16
安装依赖：
```bash
yarn or npm install
```
启动：
```bash
yarn run dev or npm run start:dev
```
部署：
```bash
yarn build or npm run build
```
### 后端
执行sql目录下ddl.sql
## 项目选型 🎯
### **后端**
- Spring Boot 2.7.0
- Spring MVC
- MySQL 数据库
- 腾讯云COS存储
- Dubbo 分布式（RPC、Nacos）
- Spring Cloud Gateway 微服务网关
- API 签名认证（Http 调用）
- IJPay-AliPay 支付宝支付
- WeiXin-Java-Pay 微信支付
- Swagger + Knife4j 接口文档
- Spring Boot Starter（SDK 开发）
- Jakarta.Mail 邮箱通知、验证码
- Spring Session Redis 分布式登录
- Apache Commons Lang3 工具类
- MyBatis-Plus 及 MyBatis X 自动生成
- Hutool、Apache Common Utils、Gson 等工具库
### 前端
- React 18
- Ant Design Pro 5.x 脚手架
- Ant Design & Procomponents 组件库
- Umi 4 前端框架
- OpenAPI 前端代码生成
## 功能介绍 📋
`坤币`即积分，用于平台接口调用。
| **功能** | 游客 | **普通用户** | **管理员** |
|------------------------------------------------------------|----|----------|---------|
| [**Cai-API-SDK**](https://github.com/poboll/cai-api-sdk)使用 | ✅ | ✅ | ✅ |
| **[开发者API在线文档](http://api-docs.caiths.com)** | ✅ | ✅ | ✅ |
| 邀请好友注册得坤币 | ❌ | ✅ | ✅ |
| 切换主题、深色、暗色 | ✅ | ✅ | ✅ |
| 微信支付宝付款 | ❌ | ✅ | ✅ |
| 在线调试接口 | ❌ | ✅ | ✅ |
| 每日签到得坤币 | ❌ | ✅ | ✅ |
| 接口大厅搜索接口、浏览接口 | ✅ | ❌ | ✅ |
| 邮箱验证码登录注册 | ✅ | ✅ | ✅ |
| 钱包充值 | ❌ | ❌ | ✅ |
| 支付成功邮箱通知(需要绑定邮箱) | ❌ | ✅ | ✅ |
| 更新头像 | ❌ | ✅ | ✅ |
| 绑定、换绑、解绑邮箱 | ❌ | ✅ | ✅ |
| 取消订单、删除订单 | ❌ | ✅ | ✅ |
| 商品管理、上线、下架 | ❌ | ❌ | ✅ |
| 用户管理、封号解封等 | ❌ | ❌ | ✅ |
| 接口管理、接口发布审核、下架 | ❌ | ❌ | ✅ |
| 退款 | ❌ | ❌ | ❌ |
## 功能展示 ✨
### 首页
### 接口广场
### 开发者在线文档
#### 首页
#### 接口介绍
### 接口描述
#### **在线API**
#### 在线调试工具
#### **错误码参考**
#### **接口调用代码示例**
### 管理页
#### 用户管理
#### 商品管理
#### 接口管理
#### 动态更新请求响应参数
### 积分商城
#### 支付宝支付
#### 支付宝支付成功
### 订单支付
### 个人信息
#### 每日签到
##### 签到成功
##### 签到失败
### 好友邀请
#### **发送邀请**
#### **接受邀请**
### 登录/注册
#### 登录
#### 注册
### 订单管理
- **我的订单**
- **详细订单**
### 主题切换
#### 浅色主题
#### 深色主题