Powerdrill

🚀 PowerDrill API 文檔

本 API 文檔將幫助您瞭解如何與 PowerDrill 服務進行交互，所有端點均通過 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 文件獲取詳細信息。