🚀 任务管理器指南

该任务管理器可助力开发过程中的任务规划与跟踪。借助集成工具和 API 端点，能有效管理和监控功能请求及其相关任务。

🚀 快速开始

1. 下载代码库：从GitHub获取最新版本。
2. 安装依赖：运行 npm install 安装所有必要的包。
3. 配置环境变量：创建 .env 文件并填写适当的值，例如数据库连接和 API 密钥。
4. 启动服务：执行 node index.js 启动任务管理器。

✨ 主要特性

计划特性 (plan_feature)

根据用户提供的特性描述生成初始任务列表。例如，输入“添加 JWT 身份验证”，系统会自动生成设计和实现步骤。

标记任务完成 (mark_task_complete)

当一个任务完成后，使用此工具标记其为已完成，并获取下一个待处理任务。

获取下一个任务 (get_next_task)

用于查看特定功能的下一步操作。

审查变化 (review_changes)

对已完成的任务进行审查，确保符合预期要求。

📦 安装指南

下载代码库

可以从GitHub下载最新的代码库。

安装依赖

使用 npm 安装所需的依赖：

npm install

配置环境变量

创建一个 .env 文件，并添加以下内容：

PORT=3000  # 服务运行的端口
DB_URL=mongodb://localhost:27017/taskdb  # 数据库连接URL
OPENAI_API_KEY=your_openai_api_key  # OpenAI API密钥

启动服务

node index.js

💻 使用示例

基础用法

计划特性 (plan_feature)

请求格式：

{
  "featureDescription": "添加JWT身份验证",
  "userId": "123"
}

响应格式：

{
  "status": "completed",
  "message": "设计身份验证流程并定义API端点。",
  "taskId": "task_001",
  "featureId": "fea_001"
}

标记任务完成 (mark_task_complete)

请求格式：

{
  "taskId": "task_001",
  "featureId": "fea_001"
}

响应格式：

{
  "status": "completed",
  "message": "完成设计身份验证流程。",
  "nextTaskId": "task_002",
  "featureId": "fea_001"
}

获取下一个任务 (get_next_task)

请求格式：

{
  "featureId": "fea_001"
}

响应格式：

{
  "status": "completed",
  "message": "实现身份验证API端点。",
  "taskId": "task_002",
  "featureId": "fea_001"
}

审查变化 (review_changes)

请求格式：

{
  "featureId": "fea_001"
}

响应格式：

{
  "status": "completed",
  "message": "代码审查通过，准备合并。",
  "featureId": "fea_001"
}

📚 详细文档

API 文档

基础 URL

所有请求应发送到 http://localhost:3000。

获取所有功能

GET /api/features

响应示例

[
  {
    "id": "fea_001",
    "description": "添加JWT身份验证"
  },
  {
    "id": "fea_002",
    "description": "实现用户认证"
  }
]

获取特定功能的任务

GET /api/tasks/fea_001

响应示例

[
  {
    "id": "task_001",
    "description": "设计身份验证流程",
    "status": "completed"
  },
  {
    "id": "task_002",
    "description": "实现身份验证API端点",
    "status": "in-progress"
  }
]

常见问题

• 问：如何处理数据库连接错误？

  答：检查 MongoDB 是否运行，确保 .env 文件中的 DB_URL 正确。

• 问：无法访问 API 端点？

  答：确认服务已成功启动，并查看控制台是否有错误信息。

更新日志

版本 1.0.0

• 初始发布，包含基本任务管理功能。

版本 2.0.0

• 增加了审查变化的功能。
• 改进了 API 文档。

集成指南

与 OpenAI 的集成

该任务管理器集成了 OpenAI 的 API，用于自动生成任务分解和代码审查。

配置 OpenAI

确保在 .env 文件中填写 OPENAI_API_KEY：

OPENAI_API_KEY=your_openai_api_key

使用 OpenAI 进行任务分解

当使用 plan_feature 工具时，系统会自动调用 OpenAI 的 API 来生成任务列表。

与 MongoDB 的集成

数据存储在 MongoDB 中，默认连接字符串为 mongodb://localhost:27017/taskdb。可以修改 .env 文件中的 DB_URL 以使用其他数据库。

安全指南

数据加密

所有敏感信息（如 API 密钥）均应加密存储，并避免在代码中明文出现。

身份验证

建议在生产环境中启用身份验证，限制对 API 端点的访问。

日志记录

实施详细的日志记录机制，便于审计和故障排除。

错误处理

• 404 Not Found：请求的资源不存在。
• 500 Internal Server Error：服务端发生错误。

联系与支持

如需帮助或报告问题，请联系 support@taskmanager.com。