Skip to content

API 概览 ​

接口说明 ​

沐霖工时管理系统提供 RESTful API 接口,所有接口返回 JSON 格式数据。

基础信息 ​

  • 基础路径: /api
  • 认证方式: JWT Token
  • 数据格式: JSON

统一返回格式 ​

json
{
  "code": 200,
  "message": "操作成功",
  "data": {}
}

状态码 ​

状态码说明
200成功
400请求参数错误
401未授权
403禁止访问
404资源不存在
500服务器内部错误

主要接口分类 ​

1. 工时接口 ​

  • POST /api/task/hour/create - 创建工时记录
  • GET /api/task/hour/list - 获取工时列表
  • GET /api/task/hour/weekly - 获取周报数据
  • PUT /api/task/hour/update - 更新工时记录
  • DELETE /api/task/hour/delete - 删除工时记录

2. 项目接口 ​

  • GET /api/project/list - 获取项目列表
  • GET /api/project/detail - 获取项目详情
  • POST /api/project/create - 创建项目
  • PUT /api/project/update - 更新项目

3. 审核接口 ​

  • GET /api/hour/review/list - 获取审核列表
  • POST /api/hour/review/approve - 审核通过
  • POST /api/hour/review/reject - 审核拒绝

4. 统计接口 ​

  • GET /api/data/hour - 工时统计
  • GET /api/data/project - 项目统计
  • GET /api/data/people - 人员统计

认证 ​

除了登录接口,所有接口都需要在请求头中携带 Token:

Authorization: Bearer <your-token>

示例 ​

获取工时列表 ​

bash
curl -X GET "http://localhost:8080/api/task/hour/list?pageNum=1&pageSize=10" \
  -H "Authorization: Bearer your-token"

创建工时记录 ​

bash
curl -X POST "http://localhost:8080/api/task/hour/create" \
  -H "Authorization: Bearer your-token" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": 1,
    "taskId": 1,
    "hour": 2.5,
    "fillDate": "2024-01-15",
    "diary": "完成用户模块开发"
  }'

下一步 ​

最后更新:

Released under the MIT License.