Powerdrill

🚀 PowerDrill API ドキュメント

PowerDrill APIへようこそ！このガイドでは、当社のサービスとのやり取り方法を説明します。すべてのエンドポイントはHTTPSを通じて提供されます。

🚀 クイックスタート

環境変数の設定

APIを設定するには、.env ファイルに以下の変数を設定してください。

PORT=8000
API_KEY=your_api_key_here

📚 ドキュメント

7つの主要な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 ファイルを参照してください。