コンテンツにスキップ

コード取得

メソッド

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}/code/{code_id}

パスパラメータ

名前 型 必須 説明
organization_id number 必須 backend PostgreSQL organization ID
project_id number 必須 backend PostgreSQL project ID
code_id string 必須 コード UUID

レスポンス

レスポンスはJSONです。

{
  "id": "0192a3b4-c5d6-4e8f-9a0b-1c2d3e4f5a6b",
  "projectId": 42,
  "name": "Button",
  "s3Key": "code/0192a3b4-c5d6-4e8f-9a0b-1c2d3e4f5a6b.png",
  "sourceCode": "const Button = () => { ... }",
  "cssCode": ".button { ... }",
  "status": 1,
  "createdAt": 1234567890000,
  "updatedAt": 1234567890000,
  "deletedAt": null,
  "createdBy": "user-id",
  "updatedBy": "user-id",
  "deletedBy": null
}

レスポンスフィールド

名前 型 説明
id string コード UUID
projectId number backend PostgreSQL project ID
name string コード名
s3Key string プレビュー画像のS3キー
sourceCode string ソースコード
cssCode string | null CSSコード
status number 処理ステータス（0 処理中、1 完了、2 失敗）
createdAt number 作成日時（エポックミリ秒）
updatedAt number 更新日時（エポックミリ秒）

認証

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

例外処理

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

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

処理フロー

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

詳細フローチャート

flowchart TD
    Start([GET Request]) --> Route[Route Handler]
    Route --> Auth[認証・パラメータ取得]
    Auth --> Service[Service Layer]

    Service --> AccessCheck[権限チェック]
    AccessCheck --> HasAccess{Read権限?}
    HasAccess -->|なし| Err404[404 Not Found]
    HasAccess -->|あり| QueryDB

    QueryDB[Repository Layer] --> FindOne[レコード取得<br/>WHERE id = ?<br/>AND projectId = ?<br/>AND deletedAt IS NULL]

    FindOne --> Exists{存在?}
    Exists -->|なし| Err404
    Exists -->|あり| Format[レスポンス整形<br/>Date→timestamp変換]

    Format --> Response[200 OK]