デザイン取得

メソッド

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

HTTPメソッド

GET: 単一デザイン情報取得

命名規則

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

リクエストとレスポンス

ヘッダー

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

リクエストヘッダー

Authorization
Content-Type
Accept
Accept-language

レスポンスヘッダー

Content-Type

単一デザイン情報取得

URI

GET /v1/organizations/{organization_id}/projects/{project_id}/designs/{design_id}

パスパラメータ

名前	型	必須	説明
organization_id	number	必須	backend PostgreSQL organization ID
project_id	number	必須	backend PostgreSQL project ID
design_id	string	必須	デザインID（形式: `{project_id}_{file_id}_{node_id}`）

レスポンス

レスポンスはJSONです。

{
  "id": "42_hDDA9BNori9OTXSClduXqR_40002029:37033",
  "projectId": 42,
  "s3Key": "1/42/design/hDDA9BNori9OTXSClduXqR/40002029-37033.png",
  "frameName": "Login Screen",
  "status": 2,
  "createdAt": 1234567890000,
  "updatedAt": 1234567890000,
  "deletedAt": null,
  "createdBy": "user-id",
  "updatedBy": "user-id",
  "deletedBy": null
}

レスポンスフィールド

名前	型	説明
id	string	デザインID（形式: `{project_id}_{file_id}_{node_id}`）
projectId	number	backend PostgreSQL project ID
s3Key	string \| null	S3オブジェクトキー
frameName	string \| null	Figmaフレーム名
status	number	処理ステータス（0-3）
createdAt	number	作成日時（エポックミリ秒）
updatedAt	number	更新日時（エポックミリ秒）

認証

認証はAmazon Cognitoから発行されるJSON Web Tokens (JWT)を使用して行われます。

例外処理

例外処理のステータスコードは以下の通りです。

説明	ステータスコード	ステータス名
認証情報不足	401	Unauthorized
実行権限不足	403	Forbidden
デザイン、プロジェクト、または組織が見つかりません	404	Not Found
内部サーバーエラー	500	Internal Server Error

処理フロー

パスパラメータから組織ID、プロジェクトID、デザインIDを抽出
ユーザーがプロジェクトへのアクセス権を持つか検証
デザインが指定されたプロジェクトに属していることを検証
デザイン情報を返却

詳細フローチャート

flowchart TD
    Start([GET Request]) --> Auth[認証・パラメータ取得]
    Auth --> Service[Service Layer]
    Service --> AccessCheck[権限チェック]
    AccessCheck --> HasAccess{Read権限?}
    HasAccess -->|なし| Err404[404 Not Found]
    HasAccess -->|あり| QueryDB[Repository Layer]
    QueryDB --> FindRecord[レコード取得<br/>WHERE deletedAt IS NULL]
    FindRecord --> Exists{存在?}
    Exists -->|なし| Err404
    Exists -->|あり| Format[レスポンス整形]
    Format --> Success[200 OK]