プロジェクト削除
メソッド
REST メソッドを採用しています。
HTTP メソッド
DELETE: プロジェクトのソフトデリート
命名規則
クエリパラメータとノードの命名を統一し、可読性を向上させるため、リクエスト時の URI と JSON 内のノードには snake_case を使用します。
リクエストとレスポンス
ヘッダー
メタ情報はレスポンスボディではなく、HTTP ヘッダーに設定されます。
リクエストヘッダー
Authorization:Bearer <access_token>Content-Type:application/json
レスポンスヘッダー
Content-Type:application/json
プロジェクト削除
URI
パスパラメータの型は integer です。
レスポンス(200 OK)
レスポンスは JSON です。プロジェクトレコードはソフトデリートされ(deletedAt が設定されます)。
{
"id": 1,
"organizationId": 1,
"name": "Project Alpha",
"createdAt": 1640995200000,
"updatedAt": 1640995200000,
"createdBy": "1111-aaaa-2222-bbbb",
"updatedBy": "1111-aaaa-2222-bbbb",
"deletedAt": 1640995200000,
"deletedBy": "1111-aaaa-2222-bbbb"
}
認証要件
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: DELETE /api/v1/projects/{project_id}
Middleware->>Middleware: Verify JWT & session
alt Token Valid
Middleware-->>API: Auth info (sub)
API->>Service: remove(id, actorSub)
Service->>DB: findOneByIdOnly(id)
DB-->>Service: Existing project
alt Project Found
Service->>DB: softDelete(id, organizationId, actorSub)
DB-->>Service: Soft-deleted project
Service-->>API: Project with deletedAt
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 パスパラメータと操作者の Cognito sub を取り出し、プロジェクトサービスに委譲します。
ソース: apps/admin/src/routes/v1/project.ts
Services 層
ビジネスロジックの説明です。プロジェクトの存在を確認し、deletedAt を設定し、操作者の Cognito sub を削除者として記録してソフトデリートします。
ソース: apps/admin/src/services/project.ts
Repositories 層
データベースへのアクセスです。プロジェクトの検索とソフトデリートを扱います。
ソース: apps/admin/src/repositories/project.ts
セキュリティ
- ハンドラ実行前に
protectedRouteミドルウェアがトークンを検証します - 操作者の Cognito sub が監査用に
deletedByとして記録されます - ソフトデリートにより復旧可能性のためデータを保持します