Claude CodeでAPI設計を効率化する方法

cd my-api-project

claude

claudeタスク管理アプリ用のREST APIを設計してください。

要件:
・ユーザー登録、ログインが必要
・タスクの作成、取得、更新、削除が必要
・タスクにはタイトル、説明、期限、完了状態を持たせる
・一覧取得ではページネーションとステータス絞り込みを使う
・認証はJWTを使う
・レスポンスはJSON形式
・エラー形式も統一してください

以下の要件をもとにREST APIのエンドポイント一覧を作成してください。

・ユーザー管理
・記事管理
・コメント管理
・認証はJWT
・管理者のみ削除可能
・一覧取得には検索、並び替え、ページネーションを含める

POST   /api/auth/register
POST   /api/auth/login
POST   /api/auth/logout
GET    /api/users/me

GET    /api/posts
POST   /api/posts
GET    /api/posts/:id
PUT    /api/posts/:id
DELETE /api/posts/:id

GET    /api/posts/:postId/comments
POST   /api/posts/:postId/comments
PUT    /api/comments/:id
DELETE /api/comments/:id

POST /api/posts のリクエストボディ、成功レスポンス、バリデーションエラーのレスポンスをJSON形式で設計してください。
TypeScriptの型定義も作成してください。

リクエスト:

{
  "title": "API設計の基本",
  "content": "API設計では一貫性が重要です。",
  "status": "draft"
}

成功レスポンス:

{
  "data": {
    "id": 1,
    "title": "API設計の基本",
    "content": "API設計では一貫性が重要です。",
    "status": "draft",
    "createdAt": "2026-05-13T10:00:00Z",
    "updatedAt": "2026-05-13T10:00:00Z"
  }
}

エラーレスポンス:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "入力内容に誤りがあります。",
    "details": [
      {
        "field": "title",
        "message": "タイトルは必須です。"
      }
    ]
  }
}

以下のAPI設計をOpenAPI 3.0形式のYAMLで作成してください。

・POST /api/auth/login
・GET /api/posts
・POST /api/posts
・GET /api/posts/{id}
・PUT /api/posts/{id}
・DELETE /api/posts/{id}

認証はBearer Tokenを使います。
レスポンス形式はdataとerrorで統一してください。

openapi: 3.0.3
info:
  title: Blog API
  version: 1.0.0

servers:
  - url: https://example.com

security:
  - bearerAuth: []

paths:
  /api/posts:
    get:
      summary: 記事一覧取得
      parameters:
        - name: page
          in: query
          schema:
            type: integer
        - name: limit
          in: query
          schema:
            type: integer
      responses:
        "200":
          description: 記事一覧取得成功
    post:
      summary: 記事作成
      responses:
        "201":
          description: 記事作成成功

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

ブログAPIの認証と権限設計を作成してください。

要件:
・一般ユーザーは記事を閲覧できる
・ログインユーザーはコメントできる
・投稿者は自分の記事を編集できる
・管理者は全記事を

権限一覧:

未ログイン:
・記事一覧取得
・記事詳細取得

ログインユーザー:
・コメント作成
・自分のコメント編集
・自分のコメント削除

投稿者:
・自分の記事作成
・自分の記事編集
・自分の記事削除

管理者:
・全記事編集
・全記事削除
・ユーザー管理

記事作成APIのバリデーションルールを作成してください。
title、content、status、publishedAtを対象にしてください。
Zodのスキーマも作成してください。

import { z } from "zod";

export const createPostSchema = z.object({
  title: z
    .string()
    .min(1, "タイトルは必須です")
    .max(100, "タイトルは100文字以内です"),

  content: z
    .string()
    .min(1, "本文は必須です"),

  status: z.enum(["draft", "published"]),

  publishedAt: z
    .string()
    .datetime()
    .optional(),
});

POST /api/posts のテストケースを作成してください。

観点:
・正常に記事を作成できる
・titleが空の場合はエラー
・contentが空の場合はエラー
・未認証の場合は401
・不正なstatusの場合は422

describe("POST /api/posts", () => {
  it("正常に記事を作成できる", async () => {
    // 認証済みユーザーでリクエスト
    // 201が返ること
    // data.idが存在すること
  });

  it("titleが空の場合は422を返す", async () => {
    // titleを空で送信
    // 422が返ること
    // error.codeがVALIDATION_ERRORであること
  });

  it("未認証の場合は401を返す", async () => {
    // Authorizationヘッダーなし
    // 401が返ること
  });
});

既存のroutesディレクトリを確認して、REST APIとして不自然なエンドポイントがあれば改善案を出してください。

このAPIのレスポンス形式を確認して、data/error形式に統一する修正案を作成してください。

ECサイト用のREST APIを設計してください。
商品、カート、注文、ユーザー、決済を対象にしてください。
認証はJWT、管理者権限も考慮してください。

このAPI設計をOpenAPI 3.0形式に変換してください。
リクエスト、レスポンス、エラー形式、認証方式も含めてください。

既存のAPIルートを確認して、命名規則、HTTPメソッド、ステータスコードの観点で改善点を出してください。

FastAPIで実装する前提で、ユーザー登録APIの設計とPydanticモデルを作成してください。

NestJSで実装する前提で、記事管理APIのController、Service、DTO、Entityを作成してください。