From 8d0eb2c28babe6f996a65c962ca498ef977f1045 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 27 Feb 2026 08:49:38 +0000 Subject: [PATCH] Add README.md --- README.en.md | 166 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 168 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 334 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..ca74c5d --- /dev/null +++ b/README.en.md @@ -0,0 +1,166 @@ +# MPay V2 Webman + +A payment system backend management API developed based on the Webman framework. + +## Project Overview + +MPay V2 Webman is a payment system backend management API built with the high-performance PHP framework Webman, providing core functionalities such as user authentication, permission management, system configuration, and menu routing. + +## Technology Stack + +- **Backend Framework**: Webman +- **PHP Version**: PHP 8.0+ +- **Database**: MySQL +- **Cache**: Redis +- **Authentication**: JWT + +## Project Structure + +``` +app/ +├── command/ # Command-line controllers +├── common/ # Common base classes +│ ├── base/ # Base classes (Controller, Model, Service, Repository) +│ ├── constants/ # Constant definitions +│ ├── enums/ # Enum classes +│ ├── middleware/ # Middleware +│ └── utils/ # Utility classes +├── events/ # Event classes +├── exceptions/ # Exception classes +├── http/ # HTTP controllers +│ └── admin/ # Backend management APIs +│ ├── controller/ # Controllers +│ └── middleware/ # Middleware +├── models/ # Data models +├── process/ # Process management +├── repositories/ # Data repositories +├── services/ # Business services +└── validation/ # Validators +config/ # Configuration files +database/ # Database scripts +doc/ # Documentation +public/ # Public resources +support/ # Framework support classes +``` + +## Core Features + +### Authentication Module +- User login/logout +- CAPTCHA generation and verification +- JWT token authentication +- User information retrieval + +### Permission Management +- Menu and route management +- User-role association + +### System Configuration +- System parameter configuration +- Dictionary management +- Form configuration +- Cache management for configurations + +### Middleware +- CORS cross-origin handling +- Static file handling +- Authentication and authorization + +## Quick Start + +### System Requirements + +- PHP >= 8.0 +- Composer +- Redis +- MySQL >= 5.7 + +### Installation Steps + +1. Clone the project +```bash +git clone https://gitee.com/technical-laohu/mpay_v2_webman.git +cd mpay_v2_webman +``` + +2. Install dependencies +```bash +composer install +``` + +3. Configure the database +Edit `config/database.php` to set up your database connection details. + +4. Configure Redis +Edit `config/redis.php` to set up your Redis connection details. + +5. Import the database +```bash +mysql -uusername -p database_name < database/ma_system_config.sql +``` + +6. Start the server +```bash +# Linux/Mac +php start.php start + +# Windows +windows.bat +``` + +## API Endpoints + +### Authentication API + +| Endpoint | Method | Description | +|----------|--------|-------------| +| `/admin/auth/captcha` | GET | Get CAPTCHA | +| `/admin/auth/login` | POST | User login | + +### User API + +| Endpoint | Method | Description | +|----------|--------|-------------| +| `/admin/user/info` | GET | Get current user information | + +### Menu API + +| Endpoint | Method | Description | +|----------|--------|-------------| +| `/admin/menu/routers` | GET | Get menu routes | + +### System API + +| Endpoint | Method | Description | +|----------|--------|-------------| +| `/admin/system/dict/{code}` | GET | Get dictionary data | +| `/admin/system/tabs` | GET | Get tab configuration | +| `/admin/system/config/{tabKey}` | GET/POST | Get/submit form configuration | + +## Exception Handling + +The project defines the following custom exception classes: + +- `BadRequestException` - Invalid request parameters (400) +- `UnauthorizedException` - Unauthorized access (401) +- `ForbiddenException` - Access forbidden (403) +- `NotFoundException` - Resource not found (404) +- `ValidationException` - Parameter validation failed (422) +- `InternalServerException` - Internal server error (500) + +## Configuration Reference + +Main configuration files are located in the `config/` directory: + +- `app.php` - Application configuration +- `database.php` - Database configuration +- `redis.php` - Redis configuration +- `jwt.php` - JWT configuration +- `route.php` - Routing configuration +- `middleware.php` - Middleware configuration +- `cache.php` - Cache configuration +- `log.php` - Log configuration + +## License + +This project is open-sourced under the MIT License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e3a628 --- /dev/null +++ b/README.md @@ -0,0 +1,168 @@ + + +# MPay V2 Webman + +基于 Webman 框架开发的支付系统后台管理 API。 + +## 项目简介 + +MPay V2 Webman 是一个采用 Webman 高性能 PHP 框架构建的支付系统后台管理接口，提供用户认证、权限管理、系统配置、菜单路由等核心功能。 + +## 技术栈 + +- **后端框架**: Webman +- **PHP 版本**: PHP 8.0+ +- **数据库**: MySQL +- **缓存**: Redis +- **认证**: JWT + +## 项目结构 + +``` +app/ +├── command/ # 命令行控制器 +├── common/ # 公共基础类 +│ ├── base/ # 基础类（Controller、Model、Service、Repository） +│ ├── constants/ # 常量定义 +│ ├── enums/ # 枚举类 +│ ├── middleware/ # 中间件 +│ └── utils/ # 工具类 +├── events/ # 事件类 +├── exceptions/ # 异常类 +├── http/ # HTTP 控制器 +│ └── admin/ # 后台管理接口 +│ ├── controller/ # 控制器 +│ └── middleware/ # 中间件 +├── models/ # 数据模型 +├── process/ # 进程管理 +├── repositories/ # 数据仓库 +├── services/ # 业务服务 +└── validation/ # 验证器 +config/ # 配置文件 +database/ # 数据库脚本 +doc/ # 文档 +public/ # 公共资源 +support/ # 框架支持类 +``` + +## 核心功能 + +### 认证模块 +- 用户登录/登出 +- 验证码生成与验证 +- JWT Token 认证 +- 用户信息获取 + +### 权限管理 +- 菜单路由管理 +- 用户角色关联 + +### 系统配置 +- 系统参数配置 +- 字典管理 +- 表单配置 +- 配置缓存管理 + +### 中间件 +- CORS 跨域处理 +- 静态文件处理 +- 认证鉴权 + +## 快速开始 + +### 环境要求 + +- PHP >= 8.0 +- Composer +- Redis +- MySQL >= 5.7 + +### 安装步骤 + +1. 克隆项目 +```bash +git clone https://gitee.com/technical-laohu/mpay_v2_webman.git +cd mpay_v2_webman +``` + +2. 安装依赖 +```bash +composer install +``` + +3. 配置数据库 +编辑 `config/database.php` 配置数据库连接信息。 + +4. 配置 Redis +编辑 `config/redis.php` 配置 Redis 连接信息。 + +5. 导入数据库 +```bash +mysql -u用户名 -p 数据库名 < database/ma_system_config.sql +``` + +6. 启动服务 +```bash +# Linux/Mac +php start.php start + +# Windows +windows.bat +``` + +## API 接口 + +### 认证接口 + +| 接口 | 方法 | 描述 | +|------|------|------| +| `/admin/auth/captcha` | GET | 获取验证码 | +| `/admin/auth/login` | POST | 用户登录 | + +### 用户接口 + +| 接口 | 方法 | 描述 | +|------|------|------| +| `/admin/user/info` | GET | 获取当前用户信息 | + +### 菜单接口 + +| 接口 | 方法 | 描述 | +|------|------|------| +| `/admin/menu/routers` | GET | 获取菜单路由 | + +### 系统接口 + +| 接口 | 方法 | 描述 | +|------|------|------| +| `/admin/system/dict/{code}` | GET | 获取字典数据 | +| `/admin/system/tabs` | GET | 获取标签页配置 | +| `/admin/system/config/{tabKey}` | GET/POST | 获取/提交表单配置 | + +## 异常处理 + +项目定义了以下自定义异常类： + +- `BadRequestException` - 请求参数错误 (400) +- `UnauthorizedException` - 未授权 (401) +- `ForbiddenException` - 禁止访问 (403) +- `NotFoundException` - 资源不存在 (404) +- `ValidationException` - 参数校验失败 (422) +- `InternalServerException` - 系统内部错误 (500) + +## 配置说明 + +主要配置文件位于 `config/` 目录： + +- `app.php` - 应用配置 +- `database.php` - 数据库配置 +- `redis.php` - Redis 配置 +- `jwt.php` - JWT 配置 +- `route.php` - 路由配置 +- `middleware.php` - 中间件配置 +- `cache.php` - 缓存配置 +- `log.php` - 日志配置 + +## 许可证 + +本项目基于 MIT 许可证开源。 \ No newline at end of file