Powerdrill

🚀 PowerDrill API Documentation

This API enables seamless interaction with our services, facilitating efficient data management and user operations.

🚀 Quick Start

Welcome to the PowerDrill API! This guide will assist you in understanding how to interact with our services. All endpoints are provided via HTTPS.

📦 Installation

Set the following variables in the .env file to configure the API:

PORT=8000
API_KEY=your_api_key_here

💻 Usage Examples

✨ Features

Here are the seven main API endpoints:

1. Create a New User

• URL: /api/users
• Method: POST
• Parameters:
  • username (Required): The username.
  • email (Required): The email address.
  • password (Required): The password.

Request Example:

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

Response Example:

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

2. Get User Details

• URL: /api/users/{id}
• Method: GET
• Parameters:
  • id (Required): The user ID.

Response Example:

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

3. Update User Information

• URL: /api/users/{id}
• Method: PUT
• Parameters:
  • id (Required): The user ID.
  • username (Optional): The new username.
  • email (Optional): The new email address.

Request Example:

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

Response Example:

{
  "message": "User updated successfully"
}

4. Delete a User

• URL: /api/users/{id}
• Method: DELETE
• Parameters:
  • id (Required): The user ID.

Response Example:

{
  "message": "User deleted successfully"
}

5. Create a New Role

• URL: /api/roles
• Method: POST
• Parameters:
  • name (Required): The role name.
  • permissions (Optional): The list of permissions.

Request Example:

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

Response Example:

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

6. Get All Roles

• URL: /api/roles
• Method: GET

Response Example:

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

7. Delete a Role

• URL: /api/roles/{id}
• Method: DELETE
• Parameters:
  • id (Required): The role ID.

Response Example:

{
  "message": "Role deleted successfully"
}

📚 Documentation

Troubleshooting

1. Ensure that the environment variables are set correctly.
2. Check your network connection.
3. Verify that the API key is valid.
4. Check the console output for more information.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.