デザインルール一覧

メソッド

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

HTTPメソッド

GET: デザインルールリスト取得

命名規則

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

リクエストとレスポンス

ヘッダー

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

リクエストヘッダー

Authorization
Content-Type
Accept
Accept-language

レスポンスヘッダー

Content-Type

リスト取得

URI

GET /api/v1/organizations/{organization_id}/projects/{project_id}/design_rules

パスパラメータ

名前	型	必須	説明
organization_id	integer	必須	組織ID
project_id	integer	必須	プロジェクトID

クエリパラメータ

リスト取得では、基本的にpage、limit、sortが定義されます。

名前	型	デフォルト	説明
page	integer	1	ページ番号（最小: 1）
limit	integer	20	ページあたりのアイテム数（最小: 1、最大: 100）
sort	string	asc	ソート順序（`asc` または `desc`）

レスポンス

レスポンスはJSONです。

{
  "currentPage": 1,
  "totalCount": 10,
  "list": [
    {
      "id": "design-rule-uuid",
      "projectId": 1,
      "name": "My Design Rule",
      "s3Key": "1/1/design-rule/design-rule-uuid",
      "createdAt": 1234567890000,
      "updatedAt": 1234567890000,
      "deletedAt": null,
      "createdBy": "user-cognito-sub",
      "updatedBy": "user-cognito-sub",
      "deletedBy": null
    }
  ]
}

レスポンスフィールド

名前	型	説明
currentPage	number	現在のページ番号
totalCount	number	総アイテム数
list	array	デザインルールオブジェクトの配列
list[].id	string	デザインルールUUID
list[].projectId	number	プロジェクトID
list[].name	string	デザインルール名
list[].s3Key	string \| null	S3オブジェクトキー
list[].createdAt	number	作成日時（エポックミリ秒）
list[].updatedAt	number	更新日時（エポックミリ秒）
list[].deletedAt	number \| null	削除日時（エポックミリ秒）。未削除の場合はnull
list[].createdBy	string	作成者のユーザーID
list[].updatedBy	string	更新者のユーザーID
list[].deletedBy	string \| null	削除者のユーザーID。未削除の場合はnull

認証

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

例外処理

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

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

処理フロー

パスパラメータから組織IDとプロジェクトIDを抽出
クエリパラメータからページネーション設定を抽出
ユーザーがプロジェクトへのアクセス権を持つか検証
ページネーション付きでデータベースからデザインルールをクエリ
ページネーション付きレスポンスを返却

詳細フローチャート

flowchart TD
    Start([GET Request]) --> Auth[認証・パラメータ取得<br/>page, limit, sort]
    Auth --> Service[Service Layer]
    Service --> AccessCheck[権限チェック]
    AccessCheck --> HasAccess{Read権限?}
    HasAccess -->|なし| Err404[404 Not Found]
    HasAccess -->|あり| Validate{sort検証}
    Validate -->|NG| Err400[400 Bad Request]
    Validate -->|OK| QueryDB[Repository Layer]
    QueryDB --> CountQuery[COUNT取得]
    CountQuery --> ListQuery[レコード取得<br/>LIMIT, OFFSET, ORDER BY]
    ListQuery --> Format[レスポンス整形]
    Format --> Success[200 OK<br/>currentPage, totalCount, list]