コンテンツにスキップ

プロジェクト取得

メソッド

REST メソッドを採用しています。

HTTP メソッド

GET: ID による単一プロジェクトの取得

命名規則

クエリパラメータとノードの命名を統一し、可読性を向上させるため、リクエスト時の URI と JSON 内のノードには snake_case を使用します。

リクエストとレスポンス

ヘッダー

メタ情報はレスポンスボディではなく、HTTP ヘッダーに設定されます。

リクエストヘッダー

  • Authorization: Bearer <access_token>
  • Content-Type: application/json

レスポンスヘッダー

  • Content-Type: application/json

プロジェクト取得

URI

パスパラメータの型は integer です。

/api/v1/projects/{project_id}

レスポンス（200 OK）

レスポンスは JSON です。

{
  "id": 1,
  "organizationId": 1,
  "name": "Project Alpha",
  "createdAt": 1640995200000,
  "updatedAt": 1640995200000,
  "createdBy": "1111-aaaa-2222-bbbb",
  "updatedBy": "1111-aaaa-2222-bbbb",
  "deletedAt": null,
  "deletedBy": null
}

認証要件

Amazon Cognito が発行する JSON Web Token（JWT）を用いた認証です。Authorization ヘッダーに有効な Bearer トークンが必要です。

例外処理

例外時のステータスコードは次のとおりです。

説明 ステータスコード ステータス名
トークンが欠落または無効 401 Unauthorized
プロジェクトが見つからない 404 Not Found
サーバ内部エラー 500 Internal Server Error

処理フロー

シーケンス図

sequenceDiagram
    participant Client
    participant Middleware as Protected Route Middleware
    participant API as Hono Router
    participant Service as Project Service
    participant DB as PostgreSQL Database

    Client->>Middleware: GET /api/v1/projects/{project_id}
    Middleware->>Middleware: Verify JWT & session

    alt Token Valid
        Middleware-->>API: Auth info
        API->>Service: getById(id)
        Service->>DB: findOneByIdOnly(id, includeDeleted=false)
        DB-->>Service: Project record

        alt Project Found
            Service-->>API: Project
            API-->>Client: 200 OK
        else Project Not Found
            Service-->>API: throw NotFoundError
            API-->>Client: 404 Not Found
        end
    else Token Invalid
        Middleware-->>Client: 401 Unauthorized
    end

Routes 層

ルーティングはここで行います。protectedRoute ミドルウェアが JWT を検証します。ハンドラは project_id パスパラメータを取り出し、プロジェクトサービスに委譲します。

ソース: apps/admin/src/routes/v1/project.ts

Services 層

ビジネスロジックの説明です。ID でプロジェクトを検索し、存在しない、またはソフトデリート済みの場合は NotFoundError を送出します。

ソース: apps/admin/src/services/project.ts

Repositories 層

データベースへのアクセスです。ID による単一プロジェクト取得を行い、ソフトデリート済みは除外します。

ソース: apps/admin/src/repositories/project.ts

セキュリティ

  • ハンドラ実行前に protectedRoute ミドルウェアがトークンを検証します
  • ソフトデリート済みプロジェクトは結果に含まれません