# catering_back **Repository Path**: idnex/catering_back ## Basic Information - **Project Name**: catering_back - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-07-09 - **Last Updated**: 2025-07-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Skyline 项目文档 ## 项目简介 这是一个基于 Express.js 的 Node.js 项目，实现了用户管理、商品管理、订单管理和商品分类管理等核心功能。项目使用 Sequelize 作为 ORM 工具，同时整合了 Swagger 提供 API 文档。 ## 项目结构 - **模型 (Models)**: 提供数据模型定义，包含用户、商品、订单、订单项和商品分类。 - **控制器 (Controllers)**: 处理 HTTP 请求，包含用户、商品、订单、商品分类的业务逻辑。 - **路由 (Routes)**: 映射 HTTP 请求到对应控制器。 - **中间件 (Middlewares)**: 包含身份验证和管理员权限检查。 - **数据库**: 包含数据库连接配置和初始化 SQL 文件。 ## 核心功能 - **用户管理**: 用户注册、登录、用户列表、查询当前用户信息、用户详情、新增用户、编辑用户、删除用户。 - **商品管理**: 获取所有商品、新增商品、修改商品、删除商品。 - **订单管理**: 创建订单、查询用户订单列表、查询订单详情、修改订单状态。 - **商品分类管理**: 获取所有分类、新增分类、修改分类、删除分类。 ## 数据模型 - **Product**: 商品模型，包含商品描述。 - **Order**: 订单模型。 - **User**: 用户模型。 - **Category**: 商品分类模型。 - **OrderItem**: 订单项模型。 ## API 文档 - **商品管理**: `/api/product` - 获取、新增、修改和删除商品。 - **订单管理**: `/api/order` - 创建订单、查询订单列表、订单详情、修改订单状态。 - **用户管理**: `/api/user` - 用户列表、查询当前用户信息、用户详情、新增用户、编辑用户、删除用户。 - **商品分类管理**: `/api/category` - 获取所有分类、新增分类、修改分类、删除分类。 - **用户注册和登录**: `/api/auth` - 用户注册和登录接口。 ## 设置与运行 1. 安装项目依赖。 2. 设置数据库配置。 3. 初始化数据库。 4. 启动应用。 5. 通过 Swagger UI 查看 API 文档。 ## 使用说明 - **用户注册**: 通过 `/api/auth/register` 接口注册新用户。 - **用户登录**: 通过 `/api/auth/login` 接口登录。 - **商品操作**: 使用 `/api/product` 接口进行商品的增删改查。 - **订单操作**: 使用 `/api/order` 接口创建和查询订单。 - **用户管理**: 使用 `/api/user` 接口管理用户。 - **分类管理**: 使用 `/api/category` 接口管理商品分类。 ## 中间件 - **auth**: 提供身份验证。 - **admin**: 提供管理员权限检查。 ## 数据库 - 包含初始化 SQL 文件，用于创建商品表和其他相关数据库表。 - 商品表定义了描述字段。 ## 开发与测试 - 项目使用 Node.js 和 Express.js 进行开发。 - 通过 Swagger 提供了完整的 API 文档和测试界面。 ## 版本控制 - 使用 Git 进行版本控制。 ## 贡献者 - 请查看用户管理模块了解贡献者信息。 ## 许可证 - 请查看项目根目录下的许可证文件。 ## 联系方式 - 项目维护者可以通过项目仓库的联系方式取得联系。 ## 附注 - 项目包含详细的注释和 Swagger API 文档。