## 项目背景 API管理与用户服务系统是一个集用户管理、API管理、套餐销售与支付管理为一体的综合平台。该系统为用户提供注册、登录、充值和套餐购买等功能,管理员则可以通过系统对API进行统一管理、用户操作日志的记录与查看,以及管理订单与支付情况。整个项目采用了RESTful架构风格,通过简洁的接口设计确保系统的可扩展性、易维护性以及与第三方服务对接的能力。 ## 功能概述 1. ##### 用户管理 - 登录、注册 - 用户账号信息管理 - 用户充值、消费记录查询 2. ##### API访问管理 - 用户密钥生成和管理 - API管理 - 调用次数和消费金额限制 - 付费套餐管理 3. ##### 支付模块 4. ##### 订单模块 - 订单生成 - 消费提醒(超额/余额不足) 5. ##### 系统监控模块 - 调用记录 - 异常告警 ## 系统依赖 - **.NET 6.0 或更高版本** - **Entity Framework Core** 用于数据库操作 - **MySQL** 作为后端数据库 - **Swagger** 用于API文档自动生成 - **JWT** 实现用户认证和授权 ## 项目结构 ```perl api-billing-system/ │ ├── API/ # API控制器及路由 ├── Services/ # 业务逻辑层 ├── Models/ # 数据模型定义 ├── Data/ # 数据库上下文及迁移文件 ├── Config/ # 系统配置文件 ├── Tests/ # 单元测试及集成测试 ├── Tools/ # 工具类 ├── README.md # 项目文档(本文件) ├── Database.md # 数据库定义文档 ├── APIDefine.md # API定义文档 └── ErrorCode.md # 错误码文档 ``` ## 模块划分 1. **API 控制器** - 负责处理用户请求并返回结果。 - 提供如用户注册、登录、查询调用次数等API端点。 1. ##### **业务逻辑层(Services)** - 负责具体业务逻辑,如套餐管理、消费计算等。 - 实现支付网关集成。 1. **数据模型(Models)** - 定义数据库中的表结构,如用户表、订单表等。 1. **数据库(Data)** - 提供数据库连接及操作支持。 - 包含数据库上下文类及数据库迁移文件。 ## 项目文档列表 - [x] 项目文档 **README.md** - [x] 数据库文档 **Database.md** - [x] 错误码文档 **ErrorCode.md** - [x] API定义文档 **APIDefine.md** - [ ] API文档 **[API文档](https://apifox.com/apidoc/shared-8730c2eb-595b-4cf4-941d-d58914d4cd1e)**