# qi-api-master **Repository Path**: other-open-source/qi-api-master ## Basic Information - **Project Name**: qi-api-master - **Description**: api接口开放平台 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2025-09-24 - **Last Updated**: 2025-09-24 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ## 项目介绍 🙋 **😀 作为用户您可以通过注册登录账户，获取接口调用权限，并根据自己的需求浏览和选择适合的接口。您可以在线进行接口调试，快速验证接口的功能和效果。** **💻 作为开发者 我们提供了[客户端SDK: Qi-API-SDK](https://github.com/qimu666/qi-api-sdk)， 通过[开发者凭证](https://api.qimuu.icu/account/center)即可将轻松集成接口到您的项目中，实现更高效的开发和调用。** **🤝 您可以将自己的接口接入到H-API 接口开放平台平台上，并发布给其他用户使用。 您可以管理和各个接口，以便更好地分析和优化接口性能。** **👌 我们还提供了[开发者在线文档](https://doc.qimuu.icu/)和技术支持，帮助您快速接入和发布接口。** **🏁 无论您是用户还是开发者，H-API 接口开放平台都致力于提供稳定、安全、高效的接口调用服务，帮助您实现更快速、便捷的开发和调用体验。** ## 目录结构 📑 | 目录 | 描述 | |--------------------------------------------------------| ------------------ | | **🏘️ [h-api-backend](./h-api-backend)** | Qi-API后端服务模块 | | **🏘️ [qi-api-common](./qi-api-common)** | 公共服务模块 | | **🕸️ [qi-api-gateway](./qi-api-gateway)** | 网关模块 | | **🔗 [qi-api-interface](./qi-api-interface)** | 接口模块 | | **🛠 [qi-qpi-sdk](https://github.com/qimu666/qi-api-sdk)** | 开发者调用sdk | | **📘 [qi-api-doc](https://doc.qimuu.icu/)** | 接口在线文档 | | **✔️ [Qi-API-SDK-Demo](https://github.com/qimu666/qi-api-sdk-demo/blob/master/src/main/java/icu/qimuu/qiapisdkdemo/controller/InvokeController.java)** | sdk调用Demo | ## 项目流程 🗺️ ![QiAPI 接口开放平台](https://img.qimuu.icu/typory/QiAPI%2520%25E6%258E%25A5%25E5%258F%25A3%25E5%25BC%2580%25E6%2594%25BE%25E5%25B9%25B3%25E5%258F%25B0.png) ## 快速启动 🚀 ### 前端 环境要求：Node.js >= 16 安装依赖： ```bash yarn or npm install ``` 启动： ```bash yarn run dev or npm run start:dev ``` 部署： ```bash yarn build or npm run build ``` ### 后端 管理员初始账号密码：admin/12345678 1. docker-compose容器编排一键启动 - 修改配置文件，修改配置部分已标记todo标签。无需特殊情况只需关注两个配置文件（已配置好不修改也可以直接运行） 1. backend配置文件 ![image-20241230195952155](https://img.qimuu.icu/typory/image-20241230195952155.png) 2.gateway网关配置文件 ![image-20241230200102128](https://img.qimuu.icu/typory/image-20241230200102128.png) - 本地maven构建jar包（跳过测试） ![image-20241230200610985](https://img.qimuu.icu/typory/image-20241230200610985.png) - 启动项目 1. 运行docker-compose.env.yml文件启动mysql、redis、nacos环境依赖 2. 运行docker-compose.service.yml文件启动后端服务 2. 普通方式：执行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 前端代码生成 ## 功能介绍 📋 `坤币`即积分，用于平台接口调用。 | **功能** | 游客 | **普通用户** | **管理员** | | ----------------------------------------------------- |--------------|-----|-----| | **[开发者API在线文档](http://doc.qimuu.icu)** | ✅ | ✅ | ✅ | | 接口大厅搜索接口、浏览接口 | ✅ | ✅ | ✅ | | 邮箱验证码登录注册 | ✅ | ✅ | ✅ | | [**Qi-API-SDK**](https://github.com/qimu666/qi-api-sdk)使用 | ❌ | ✅ | ✅ | | 邀请好友注册得坤币 | ❌ | ✅ | ✅ | | 微信支付宝付款 | ❌ | ✅ | ✅ | | 在线调试接口 | ❌ | ✅ | ✅ | | 每日签到得坤币 | ❌ | ✅ | ✅ | | 钱包充值 | ❌ | ✅ | ✅ | | 支付成功邮箱通知(需要绑定邮箱) | ❌ | ✅ | ✅ | | 更新头像 | ❌ | ✅ | ✅ | | 绑定、换绑、解绑邮箱 | ❌ | ✅ | ✅ | | 取消订单、删除订单 | ❌ | ✅ | ✅ | | 商品管理、上线、下架 | ❌ | ❌ |✅| | 用户管理、封号解封等 | ❌ | ❌ | ✅ | | 接口管理、接口发布审核、下架 | ❌ | ❌ | ✅ | | 退款 | ❌ | ❌| ❌ | ## 新接口动态发布示例（只需两步即可发布） 1. 在接口服务(interface)项目中开发新接口 （**接口服务可以是独立的项目，但需要在网关中配置路由**） 在接口服务开发一个测试接口： ```java @GetMapping("/test") public String test(String text) { return text; } ``` ![image-20241231114908610](https://img.qimuu.icu/typory/image-20241231114908610.png) 2. 开发完成后重启接口项目后，在管理员后台发布接口，就可以在线调用了！！ ![image-20241231115154224](https://img.qimuu.icu/typory/image-20241231115154224.png) 3. 在接口大厅找到并请求接口 ![image-20241231115407585](https://img.qimuu.icu/typory/image-20241231115407585.png) 4. 恭喜发布成功！！ ## 功能展示 ✨ ### 首页 ![index](https://img.qimuu.icu/typory/image-20241230233443136.png) ### 接口广场 ![interfaceSquare](https://img.qimuu.icu/typory/interfaceSquare.png) ### 开发者在线文档 ![api](https://img.qimuu.icu/typory/api.png) ![api2](https://img.qimuu.icu/typory/api2.png) ### 接口描述 #### **在线API** ![interfaceinfo-api](https://img.qimuu.icu/typory/interfaceinfo-api.png) #### 在线调试工具![interfaceinfo-tools](https://img.qimuu.icu/typory/interfaceinfo-tools.png) #### **错误码参考**![interfaceinfo-errorcode](https://img.qimuu.icu/typory/interfaceinfo-errorcode.png) #### **接口调用代码示例**![interfaceinfo-sampleCode](https://img.qimuu.icu/typory/interfaceinfo-sampleCode.png) ### 管理页 #### 用户管理 ![admin-userManagement](https://img.qimuu.icu/typory/admin-userManagement.png) #### 商品管理![admin-productManagement](https://img.qimuu.icu/typory/admin-productManagement.png) #### 接口管理![admin-interfaceManagement](https://img.qimuu.icu/typory/admin-interfaceManagement.png) #### 动态更新请求响应参数![dynamicRequestParameters](https://img.qimuu.icu/typory/dynamicRequestParameters.png) ### 积分商城 ![pointPurchase](https://img.qimuu.icu/typory/pointPurchase.png) ### 订单支付![pay](https://img.qimuu.icu/typory/pay.png) ### 个人信息 #### 信息展示 ![userinfo](https://img.qimuu.icu/typory/userinfo.png) #### 每日签到 ##### 签到成功![successfullySignedIn](https://img.qimuu.icu/typory/successfullySignedIn.png) ##### 签到失败![errorfullySignedIn](https://img.qimuu.icu/typory/errorfullySignedIn.png) ### 好友邀请 #### **发送邀请**![Invitefriends](https://img.qimuu.icu/typory/Invitefriends.png) #### **接收邀请**![registerThroughInvitationCode](https://img.qimuu.icu/typory/registerThroughInvitationCode.png) ### 登录/注册![login](https://img.qimuu.icu/typory/login.png) ![register](https://img.qimuu.icu/typory/register.png) ### 订单管理 - **我的订单**![orderinfo](https://img.qimuu.icu/typory/orderinfo.png) - **详细订单**![orderDetails](https://img.qimuu.icu/typory/orderDetails.png)