Update README.md
This commit is contained in:
parent
7b22e66310
commit
8309927364
78
README.md
78
README.md
@ -1 +1,77 @@
|
|||||||
# Apimanager_backend
|
## 项目背景
|
||||||
|
|
||||||
|
简单描述该API的背景、用途及目标用户。
|
||||||
|
|
||||||
|
## 功能概述
|
||||||
|
|
||||||
|
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 # 项目文档(本文件)
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 模块划分
|
||||||
|
|
||||||
|
1. **API 控制器**
|
||||||
|
|
||||||
|
- 负责处理用户请求并返回结果。
|
||||||
|
- 提供如用户注册、登录、查询调用次数等API端点。
|
||||||
|
|
||||||
|
1. ##### **业务逻辑层(Services)**
|
||||||
|
|
||||||
|
- 负责具体业务逻辑,如套餐管理、消费计算等。
|
||||||
|
- 实现支付网关集成。
|
||||||
|
|
||||||
|
1. **数据模型(Models)**
|
||||||
|
|
||||||
|
- 定义数据库中的表结构,如用户表、订单表等。
|
||||||
|
|
||||||
|
1. **数据库(Data)**
|
||||||
|
|
||||||
|
- 提供数据库连接及操作支持。
|
||||||
|
- 包含数据库上下文类及数据库迁移文件。
|
||||||
Loading…
Reference in New Issue
Block a user