# cms-interface

**Repository Path**: he-meiyi/cms-interface

## Basic Information

- **Project Name**: cms-interface
- **Description**: Koa框架实现通用后台管理系统所需的接口，包括用户登录、权限管理、商品信息管理等（后端api）
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://apifox.com/apidoc/shared-a82f1bbd-563a-4c9b-80fd-fae4fa3e2f57
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-17
- **Last Updated**: 2024-01-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# 本项目为通用后台管理系统提供接口

# 项目描述

## 1. 官方主页

本项目为通用后台管理系统提供接口：https://apifox.com/apidoc/shared-a82f1bbd-563a-4c9b-80fd-fae4fa3e2f57

通用后台管理系统:[hmy_managerial_system: 基于Vue3 + TS + Vite + Pinia+ Echarts + Vite 实现的一个高度封装的后台管理系统，管理系统包含用户管理、部门管理、角色管理等功能，大致的功能点有：权限控制，登录不同账号系统会显示不同的菜单栏、常见的增删改查、Element-plus的使用、Echarts5.x的基本使用、富文本编辑器的使用等 (gitee.com)](https://gitee.com/he-meiyi/hmy_managerial_system)

## 2. 介绍

本项目基于Koa框架实现用户登录、系统管理、商品管理、故事杂谈、高级查询和图表数据等接口。在系统管理中，有用户管理、部门管理、角色管理和菜单管理等接口。整体目标是提供后台管理系统所需的功能，包括用户登录、权限管理、商品信息管理等

### 技术栈

- **Koa**: 一个基于Node.js的Web框架，轻量且高效。
- **Koa Router**: Koa的路由中间件，用于处理HTTP请求和响应。
- **Koa Multer**: 处理`multipart/form-data`类型的请求，用于文件上传。
- **Dayjs**: 一个轻量级的时间处理库，用于处理日期和时间。
- **Dotenv**: 用于加载环境变量的零依赖模块。
- **JSON Web Token (jsonwebtoken)**: 生成和验证JSON Web Tokens，用于身份验证。
- **Koa Bodyparser**: 解析请求体，支持JSON和表单类型。
- **Multer**: 用于Node.js的文件上传中间件。
- **MySQL2**: MySQL数据库的Node.js驱动程序。
- **Log4js**: 用于记录日志的Node.js库。
- **Koa2 CORS**: 处理Koa应用的CORS（跨域资源共享）中间件。
- **Nodemon**: 监视文件更改并自动重新启动Node.js应用程序。

### 开发工具

- **Husky**: Git Hooks工具，用于在Git操作前执行脚本。
- **ESLint**: JavaScript和TypeScript的静态代码分析工具。
- **Prettier**: 代码格式化工具，用于保持代码一致性。
- **Commitlint**: 用于规范化提交消息的工具。
- **Commitizen**: 用于生成符合约定的提交消息的工具。
- **CZ Conventional Changelog**: Commitizen的适配器，用于生成符合规范的提交消息。

## 3. 安装

```
npm install
```

## 4. 快速开始

```
npm run start
```

## 5. 功能列表

| **接口分类**         | **接口数量** | **描述**                                 |
| -------------------- | ------------ | ---------------------------------------- |
| 用户登录             | 2            | 用户登录、登出                           |
| 系统管理             | 20           | 系统用户、部门、角色管理                 |
| （系统管理）用户管理 | 5            | 获取用户列表、新增、编辑、删除、重置密码 |
| （系统管理）部门管理 | 5            | 获取部门列表、新增、编辑、删除、部门详情 |
| （系统管理）角色管理 | 5            | 获取角色列表、新增、编辑、删除           |
| （系统管理）菜单管理 | 5            | 获取角色列表、新增、编辑、删除           |
| 商品管理             | 10           | 商品信息、商品分类                       |
| (商品管理)  商品信息 | 5            | 获取商品列表、新增、编辑、删除、商品详情 |
| (商品管理)  商品分类 | 5            | 获取分类列表、新增、编辑、删除、分类详情 |
| 故事杂谈             | 2            | 故事杂谈相关接口                         |
| 高级查询             | 4            | 高级查询相关接口                         |
| 图表数据             | 6            | 图表数据相关接口                         |