# chartmgt **Repository Path**: kingecg/chartmgt ## Basic Information - **Project Name**: chartmgt - **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-06-30 - **Last Updated**: 2025-07-01 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # ECharts Config Manager 一个用于管理和存储ECharts图表配置的RESTful API服务。 ## 功能特点 - 存储和管理ECharts图表配置 - RESTful API接口 - MongoDB数据存储 - 支持配置搜索 - 请求验证 - 错误处理 - 日志记录 - 安全防护(Helmet, Rate Limiting) - API文档 ## 技术栈 - Node.js - Express.js - MongoDB - Mongoose - Winston (日志) - Joi (验证) - Jest (测试) ## 安装 1. 克隆仓库: ```bash git clone cd echarts-config-manager ``` 2. 安装依赖: ```bash npm install ``` 3. 配置环境变量: 复制`.env.example`文件为`.env`并根据需要修改配置: ```bash cp .env.example .env ``` 4. 启动服务: ```bash # 开发模式 npm run dev # 生产模式 npm start ``` ## API接口 ### 获取配置列表 ```http GET /api/configs ``` 查询参数: - `page` (可选): 页码,默认1 - `limit` (可选): 每页数量,默认10 - `sortBy` (可选): 排序字段 (name/createdAt/updatedAt),默认createdAt - `order` (可选): 排序方向 (asc/desc),默认desc ### 搜索配置 ```http GET /api/configs/search ``` 查询参数: - `q`: 搜索关键词 - `page` (可选): 页码,默认1 - `limit` (可选): 每页数量,默认10 - `sortBy` (可选): 排序字段 (name/createdAt/updatedAt),默认createdAt - `order` (可选): 排序方向 (asc/desc),默认desc ### 获取单个配置 ```http GET /api/configs/:id ``` ### 创建配置 ```http POST /api/configs ``` 请求体: ```json { "name": "图表名称", "description": "图表描述", "config": { // ECharts配置对象 }, "tags": ["标签1", "标签2"] } ``` ### 更新配置 ```http PUT /api/configs/:id ``` 请求体: ```json { "name": "新图表名称", "description": "新图表描述", "config": { // 更新的ECharts配置对象 }, "tags": ["新标签1", "新标签2"] } ``` ### 删除配置 ```http DELETE /api/configs/:id ``` ## 开发 ### 运行测试 ```bash npm test ``` ### 代码检查 ```bash npm run lint ``` ## 部署 1. 确保MongoDB服务可用 2. 设置正确的环境变量 3. 构建并启动服务: ```bash npm install --production npm start ``` ## 安全性考虑 - 使用Helmet中间件增强安全性 - 实施速率限制防止滥用 - 验证所有输入数据 - 使用环境变量管理敏感信息 ## 许可证 MIT