Skip to content

Elaine2048/workLogService

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

工作日志服务端 (WorkLogService)

这是 worklogpro 项目的后端服务,提供工作日志的 API 接口。

功能特性

  • 📅 根据月份获取工作日志列表
  • ✏️ 更新工作日志记录
  • 🔍 健康检查接口
  • 🌐 CORS 跨域支持

技术栈

  • Node.js
  • Express.js
  • CORS
  • dotenv

快速开始

安装依赖

npm install

启动开发服务器

npm run dev

启动生产服务器

npm start

API 接口

1. 健康检查

GET /api/health

响应示例:

{
  "success": true,
  "message": "工作日志服务运行正常",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

2. 获取工作日志列表

GET /api/worklogs?year=2024&month=1

参数:

  • year: 年份 (必需)
  • month: 月份 (必需)

响应示例:

{
  "success": true,
  "data": [
    {
      "id": "1",
      "date": "2024-01-15",
      "dayOfWeek": "周一",
      "plan": ["完成项目文档", "代码审查"],
      "actual": ["完成项目文档"],
      "isPlanCompleted": false,
      "problems": ["时间不够"],
      "summary": ["效率需要提升"],
      "pending": ["代码审查"]
    }
  ]
}

3. 更新工作日志

PUT /api/worklogs/:id

请求体示例:

{
  "plan": ["新计划"],
  "actual": ["已完成"],
  "isPlanCompleted": true,
  "problems": [],
  "summary": ["进展顺利"],
  "pending": []
}

响应示例:

{
  "success": true,
  "data": {
    "id": "1",
    "date": "2024-01-15",
    "dayOfWeek": "周一",
    "plan": ["新计划"],
    "actual": ["已完成"],
    "isPlanCompleted": true,
    "problems": [],
    "summary": ["进展顺利"],
    "pending": []
  },
  "message": "工作日志更新成功"
}

环境配置

创建 .env 文件:

PORT=3001
NODE_ENV=development
CORS_ORIGIN=http://localhost:3000

开发说明

  • 服务默认运行在 http://localhost:3001
  • 支持 CORS 跨域请求
  • 使用内存存储模拟数据
  • 支持 JSON 格式的请求和响应

未来扩展

  • 数据库集成 (PostgreSQL/MongoDB)
  • 用户认证和授权
  • 数据验证中间件
  • 日志记录
  • 单元测试
  • API 文档 (Swagger)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published