API一覧

API名 メソッド エンドポイント 概要
Create Work POST /works/create 新規Workを作成する
Update Work POST /works/update 既存Workを全項目上書き更新する
Delete Work POST /works/delete Workを削除する
List Works GET /works/:id ログインユーザーのWork一覧を取得

🔐 共通ヘッダー（APIキー方式）

すべてのAPIで以下のヘッダーを付与する必要がある：

ヘッダー名 必須 内容
Authorization ✅ Bearer <API_KEY>（バックエンド側で発行）
Content-Type ✅ application/json（POST時のみ必要）

📘 共通レスポンスフォーマット

すべてのAPIで以下のような統一された構造を使う：

1. 成功（ステータスのみ返す場合）

2. 成功 + 追加情報（以下Create時の例）

3. エラー

🌐 HTTPステータスコード対応表

ステータスコード 説明 適用場面例
200 OK 正常成功 データ取得・更新・削除
201 Created 新規リソース作成成功 create 成功時
400 Bad Request 不正なパラメータ バリデーションエラー・不正なリクエスト構造など
401 Unauthorized 認証失敗 トークン無効・未ログイン
404 Not Found リソースが存在しない ID指定ミスなど
500 Internal Server Error サーバー内部エラー 例外など、予期せぬ処理失敗

🧾 エラーパターン一覧（共通コード）

エラーコード 内容 想定シーン例
INVALID_PARAM リクエストパラメータの形式や値が不正 必須項目が未入力・型ミスなど
UNAUTHORIZED 認証情報が無効または存在しない トークンがない・Googleログイン未通過
NOT_FOUND 対象のデータが存在しない 指定した ID のレコードが無い
INTERNAL_ERROR サーバー内部で予期せぬエラーが発生した 例外処理漏れなど