|
1 |
| -# Ant Design Pro |
| 1 | +<p align="center"> |
| 2 | + <img src=https://github.com/user-attachments/assets/f7c5f6bb-164d-4ec5-8e35-720e5076a50c width=188/> |
| 3 | +</p> |
| 4 | +<h1 align="center">Cai-API 接口开放平台</h1> |
| 5 | +<p align="center"><strong>Cai-API 接口开放平台是一个为用户和开发者提供全面API接口调用服务的平台 🛠</strong></p> |
| 6 | +<div align="center"> |
| 7 | +<a target="_blank" href="https://github.com/poboll/cai-api"> |
| 8 | + <img alt="" src="https://github.com/poboll/cai-api/badge/star.svg?theme=gvp"/> |
| 9 | +</a> |
| 10 | +<a target="_blank" href="https://github.com/poboll/cai-api"> |
| 11 | + <img alt="" src="https://img.shields.io/github/stars/poboll/cai-api.svg?style=social&label=Stars"/> |
| 12 | +</a> |
| 13 | + <img alt="Maven" src="https://raster.shields.io/badge/Maven-3.8.1-red.svg"/> |
| 14 | +<a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html"> |
| 15 | + <img alt="" src="https://img.shields.io/badge/JDK-1.8+-green.svg"/> |
| 16 | +</a> |
| 17 | + <img alt="SpringBoot" src="https://raster.shields.io/badge/SpringBoot-2.7+-green.svg"/> |
| 18 | +<a href="https://github.com/poboll/cai-api" target="_blank"> |
| 19 | + <img src='https://img.shields.io/github/forks/poboll/cai-api' alt='GitHub forks' class="no-zoom"> |
| 20 | +</a> |
| 21 | +<a href="https://github.com/poboll/cai-api" target="_blank"><img src='https://img.shields.io/github/stars/poboll/cai-api' alt='GitHub stars' class="no-zoom"> |
| 22 | +</a> |
| 23 | +</div> |
2 | 24 |
|
3 |
| -This project is initialized with [Ant Design Pro](https://pro.ant.design). Follow is the quick guide for how to use. |
| 25 | +## 项目介绍 🙋 |
4 | 26 |
|
5 |
| -## Environment Prepare |
6 | 27 |
|
7 |
| -Install `node_modules`: |
8 | 28 |
|
9 |
| -```bash |
10 |
| -npm install |
11 |
| -``` |
| 29 | +**😀 作为用户您可以通过注册登录账户,获取接口调用权限,并根据自己的需求浏览和选择适合的接口。您可以在线进行接口调试,快速验证接口的功能和效果。** |
12 | 30 |
|
13 |
| -or |
| 31 | +**💻 作为开发者 我们提供了[客户端SDK: Cai-API-SDK](https://github.com/poboll/cai-api-sdk), 通过[开发者凭证](https://api.caiths.com/account/center)即可将轻松集成接口到您的项目中,实现更高效的开发和调用。** |
14 | 32 |
|
15 |
| -```bash |
16 |
| -yarn |
17 |
| -``` |
| 33 | +**🤝 您可以将自己的接口接入到Cai-API 接口开放平台平台上,并发布给其他用户使用。 您可以管理和各个接口,以便更好地分析和优化接口性能。** |
18 | 34 |
|
19 |
| -## Provided Scripts |
| 35 | +**👌 我们还提供了[开发者在线文档](https://api-docs.caiths.com)和技术支持,帮助您快速接入和发布接口。** |
20 | 36 |
|
21 |
| -Ant Design Pro provides some useful script to help you quick start and build with web project, code style check and test. |
| 37 | +**🏁 无论您是用户还是开发者,Cai-API 接口开放平台都致力于提供稳定、安全、高效的接口调用服务,帮助您实现更快速、便捷的开发和调用体验。** |
22 | 38 |
|
23 |
| -Scripts provided in `package.json`. It's safe to modify or add additional script: |
| 39 | +## 网站导航 🧭 |
24 | 40 |
|
25 |
| -### Start project |
| 41 | +- [**Cai-API 后端 🏘️**](https://github.com/poboll/cai-api) |
| 42 | +- [**Cai-API 前端 🏘**️](https://github.com/poboll/cai-api-frontend) |
26 | 43 |
|
27 |
| -```bash |
28 |
| -npm start |
29 |
| -``` |
| 44 | +- **[Cai-API-SDK](https://github.com/poboll/cai-api-sdk)** 🛠 |
30 | 45 |
|
31 |
| -### Build project |
| 46 | +- **[Cai-API 接口开放平台 🔗](https://api.caiths.com/)** |
32 | 47 |
|
33 |
| -```bash |
34 |
| -npm run build |
35 |
| -``` |
| 48 | +- **[Cai-API-DOC 开发者文档 📖](https://api-docs.caiths.com)** |
| 49 | +- **[Cai-API-SDK-demo ✔️](https://github.com/poboll/cai-api-sdk-demo/blob/main/src/main/java/com/caiths/caiapisdkdemo/controller/InvokeController.java)** |
| 50 | + |
| 51 | + |
| 52 | +## 目录结构 📑 |
| 53 | + |
| 54 | + |
| 55 | +| 目录 | 描述 | |
| 56 | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| |
| 57 | +| **🏘️ [cai-api-backend](https://github.com/poboll/cai-api/cai-api-backend)** | Cai-API后端服务模块 | |
| 58 | +| **🏘️ [cai-api-common](https://github.com/poboll/cai-api/cai-api-common)** | 公共服务模块 | |
| 59 | +| **🕸️ [cai-api-gateway](https://github.com/poboll/cai-api/cai-api-gateway)** | 网关模块 | |
| 60 | +| **🔗 [cai-api-interface](https://github.com/poboll/cai-api/cai-api-interface)** | 接口模块 | |
| 61 | +| **🛠 [cai-qpi-sdk](https://github.com/poboll/cai-api-sdk)** | 开发者调用sdk | |
| 62 | +| **📘 [cai-api-doc](https://api-docs.caiths.com)** | 接口在线文档 | |
| 63 | +| **✔️ [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 | |
| 64 | + |
| 65 | +## 项目流程 🗺️ |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +## 快速启动 🚀 |
| 70 | + |
| 71 | +### 前端 |
| 72 | + |
| 73 | +环境要求:Node.js >= 16 |
36 | 74 |
|
37 |
| -### Check code style |
| 75 | +安装依赖: |
38 | 76 |
|
39 | 77 | ```bash
|
40 |
| -npm run lint |
| 78 | +yarn or npm install |
41 | 79 | ```
|
42 | 80 |
|
43 |
| -You can also use script to auto fix some lint error: |
| 81 | +启动: |
44 | 82 |
|
45 | 83 | ```bash
|
46 |
| -npm run lint:fix |
| 84 | +yarn run dev or npm run start:dev |
47 | 85 | ```
|
48 | 86 |
|
49 |
| -### Test code |
| 87 | +部署: |
50 | 88 |
|
51 | 89 | ```bash
|
52 |
| -npm test |
| 90 | +yarn build or npm run build |
53 | 91 | ```
|
54 | 92 |
|
55 |
| -## More |
| 93 | +### 后端 |
| 94 | + |
| 95 | +执行sql目录下ddl.sql |
| 96 | + |
| 97 | +## 项目选型 🎯 |
| 98 | + |
| 99 | +### **后端** |
| 100 | + |
| 101 | +- Spring Boot 2.7.0 |
| 102 | +- Spring MVC |
| 103 | +- MySQL 数据库 |
| 104 | +- 腾讯云COS存储 |
| 105 | +- Dubbo 分布式(RPC、Nacos) |
| 106 | +- Spring Cloud Gateway 微服务网关 |
| 107 | +- API 签名认证(Http 调用) |
| 108 | +- IJPay-AliPay 支付宝支付 |
| 109 | +- WeiXin-Java-Pay 微信支付 |
| 110 | +- Swagger + Knife4j 接口文档 |
| 111 | +- Spring Boot Starter(SDK 开发) |
| 112 | +- Jakarta.Mail 邮箱通知、验证码 |
| 113 | +- Spring Session Redis 分布式登录 |
| 114 | +- Apache Commons Lang3 工具类 |
| 115 | +- MyBatis-Plus 及 MyBatis X 自动生成 |
| 116 | +- Hutool、Apache Common Utils、Gson 等工具库 |
| 117 | + |
| 118 | +### 前端 |
| 119 | + |
| 120 | +- React 18 |
| 121 | + |
| 122 | +- Ant Design Pro 5.x 脚手架 |
| 123 | + |
| 124 | +- Ant Design & Procomponents 组件库 |
| 125 | + |
| 126 | +- Umi 4 前端框架 |
| 127 | + |
| 128 | +- OpenAPI 前端代码生成 |
| 129 | + |
| 130 | + |
| 131 | + |
| 132 | +## 功能介绍 📋 |
| 133 | + |
| 134 | +`坤币`即积分,用于平台接口调用。 |
| 135 | + |
| 136 | +| **功能** | 游客 | **普通用户** | **管理员** | |
| 137 | +|------------------------------------------------------------|----|----------|---------| |
| 138 | +| [**Cai-API-SDK**](https://github.com/poboll/cai-api-sdk)使用 | ✅ | ✅ | ✅ | |
| 139 | +| **[开发者API在线文档](http://api-docs.caiths.com)** | ✅ | ✅ | ✅ | |
| 140 | +| 邀请好友注册得坤币 | ❌ | ✅ | ✅ | |
| 141 | +| 切换主题、深色、暗色 | ✅ | ✅ | ✅ | |
| 142 | +| 微信支付宝付款 | ❌ | ✅ | ✅ | |
| 143 | +| 在线调试接口 | ❌ | ✅ | ✅ | |
| 144 | +| 每日签到得坤币 | ❌ | ✅ | ✅ | |
| 145 | +| 接口大厅搜索接口、浏览接口 | ✅ | ❌ | ✅ | |
| 146 | +| 邮箱验证码登录注册 | ✅ | ✅ | ✅ | |
| 147 | +| 钱包充值 | ❌ | ❌ | ✅ | |
| 148 | +| 支付成功邮箱通知(需要绑定邮箱) | ❌ | ✅ | ✅ | |
| 149 | +| 更新头像 | ❌ | ✅ | ✅ | |
| 150 | +| 绑定、换绑、解绑邮箱 | ❌ | ✅ | ✅ | |
| 151 | +| 取消订单、删除订单 | ❌ | ✅ | ✅ | |
| 152 | +| 商品管理、上线、下架 | ❌ | ❌ | ✅ | |
| 153 | +| 用户管理、封号解封等 | ❌ | ❌ | ✅ | |
| 154 | +| 接口管理、接口发布审核、下架 | ❌ | ❌ | ✅ | |
| 155 | +| 退款 | ❌ | ❌ | ❌ | |
| 156 | + |
| 157 | +## 功能展示 ✨ |
| 158 | + |
| 159 | +### 首页 |
| 160 | + |
| 161 | + |
| 162 | + |
| 163 | +### 接口广场 |
| 164 | + |
| 165 | + |
| 166 | + |
| 167 | +### 开发者在线文档 |
| 168 | + |
| 169 | +#### 首页 |
| 170 | + |
| 171 | + |
| 172 | +#### 接口介绍 |
| 173 | + |
| 174 | + |
| 175 | +### 接口描述 |
| 176 | + |
| 177 | +#### **在线API** |
| 178 | + |
| 179 | + |
| 180 | +#### 在线调试工具 |
| 181 | + |
| 182 | + |
| 183 | +#### **错误码参考** |
| 184 | + |
| 185 | + |
| 186 | +#### **接口调用代码示例** |
| 187 | + |
| 188 | + |
| 189 | +### 管理页 |
| 190 | + |
| 191 | +#### 用户管理 |
| 192 | + |
| 193 | + |
| 194 | +#### 商品管理 |
| 195 | + |
| 196 | + |
| 197 | +#### 接口管理 |
| 198 | + |
| 199 | + |
| 200 | +#### 动态更新请求响应参数 |
| 201 | + |
| 202 | + |
| 203 | +### 积分商城 |
| 204 | + |
| 205 | + |
| 206 | +#### 支付宝支付 |
| 207 | + |
| 208 | + |
| 209 | +#### 支付宝支付成功 |
| 210 | + |
| 211 | + |
| 212 | +### 订单支付 |
| 213 | + |
| 214 | + |
| 215 | +### 个人信息 |
| 216 | + |
| 217 | +#### 每日签到 |
| 218 | +##### 签到成功 |
| 219 | + |
| 220 | + |
| 221 | +##### 签到失败 |
| 222 | + |
| 223 | + |
| 224 | +### 好友邀请 |
| 225 | + |
| 226 | +#### **发送邀请** |
| 227 | + |
| 228 | + |
| 229 | +#### **接受邀请** |
| 230 | + |
| 231 | + |
| 232 | +### 登录/注册 |
| 233 | +#### 登录 |
| 234 | + |
| 235 | + |
| 236 | +#### 注册 |
| 237 | + |
| 238 | + |
| 239 | +### 订单管理 |
| 240 | + |
| 241 | +- **我的订单** |
| 242 | + |
| 243 | +- **详细订单** |
| 244 | + |
| 245 | +### 主题切换 |
| 246 | + |
| 247 | +#### 浅色主题 |
56 | 248 |
|
57 |
| -You can view full document on our [official website](https://pro.ant.design). And welcome any feedback in our [github](https://github.com/ant-design/ant-design-pro). |
| 249 | +#### 深色主题 |
0 commit comments