powerdrill

🚀 PowerDrill API 文档

PowerDrill API 为您提供便捷的服务交互方式，本指南将详细介绍如何与我们的服务进行交互，所有端点均通过 HTTPS 提供。

🚀 快速开始

环境变量配置

在 .env 文件中设置以下变量以完成 API 配置：

PORT=8000
API_KEY=your_api_key_here

📚 详细文档

七个主要的 API 端点

1. 创建新用户

• URL：/api/users
• 方法：POST
• 参数：
  • username（必需）：用户名。
  • email（必需）：邮箱地址。
  • password（必需）：密码。

请求示例：

{
  "username": "john",
  "email": "john@example.com",
  "password": "secure_password"
}

响应示例：

{
  "id": "12345678-9abc-defg-1234-567890abcdef",
  "username": "john",
  "email": "john@example.com"
}

2. 获取用户详细信息

• URL：/api/users/{id}
• 方法：GET
• 参数：
  • id（必需）：用户 ID。

响应示例：

{
  "user": {
    "id": "12345678-9abc-defg-1234-567890abcdef",
    "username": "john",
    "email": "john@example.com",
    "created_at": "2024-03-15T10:00:00Z"
  }
}

3. 更新用户信息

• URL：/api/users/{id}
• 方法：PUT
• 参数：
  • id（必需）：用户 ID。
  • username（可选）：新用户名。
  • email（可选）：新邮箱地址。

请求示例：

{
  "username": "johndoe",
  "email": "johndoe@example.com"
}

响应示例：

{
  "message": "User updated successfully"
}

4. 删除用户

• URL：/api/users/{id}
• 方法：DELETE
• 参数：
  • id（必需）：用户 ID。

响应示例：

{
  "message": "User deleted successfully"
}

5. 创建新角色

• URL：/api/roles
• 方法：POST
• 参数：
  • name（必需）：角色名称。
  • permissions（可选）：授权列表。

请求示例：

{
  "name": "admin",
  "permissions": ["read", "write"]
}

响应示例：

{
  "id": "1-2-3-4-5",
  "name": "admin"
}

6. 获取所有角色

• URL：/api/roles
• 方法：GET

响应示例：

[
  {
    "id": "1-2-3-4-5",
    "name": "admin"
  },
  {
    "id": "6-7-8-9-0",
    "name": "user"
  }
]

7. 删除角色

• URL：/api/roles/{id}
• 方法：DELETE
• 参数：
  • id（必需）：角色 ID。

响应示例：

{
  "message": "Role deleted successfully"
}

故障排除

1. 确保已正确设置环境变量。
2. 检查网络连接。
3. 验证 API 密钥是否有效。
4. 查看控制台输出以获取更多信息。

📄 许可证

本项目遵循 MIT 许可证。请查阅 LICENSE 文件获取详细信息。