API ドキュメントを作成するプロンプト

このプロンプトでできること

開発者向けのAPIドキュメントを、サンプルコード付きで作成します。

プロンプト

以下のAPIのドキュメントを作成してください。

## API概要
- エンドポイント: {エンドポイント}
- メソッド: {GET/POST/PUT/DELETE}
- 機能: {何をするAPIか}

## パラメータ
{リクエストパラメータ}

## レスポンス
{レスポンスの形式}

## 認証
{認証方式}

## 出力形式
1. 概要
2. エンドポイント
3. リクエスト仕様
4. レスポンス仕様
5. エラーコード
6. サンプルコード（curl, Python, JavaScript）
7. 注意事項

出力例

ユーザー情報取得 API

---

概要 指定したユーザーIDのユーザー情報を取得します。

エンドポイント

GET /api/v1/users/{user_id}

認証 Bearer Token（必須）

---

リクエスト

パスパラメータ

パラメータ	型	必須	説明
user_id	string	Yes	ユーザーID

ヘッダー

ヘッダー	値
Authorization	Bearer {token}

---

レスポンス（200 OK）

{
  "id": "usr_123",
  "email": "user@example.com",
  "name": "山田 太郎",
  "created_at": "2025-01-01T00:00:00Z"
}

エラーコード

コード	説明
401	認証エラー
404	ユーザーが見つからない

---

サンプルコード

curl

curl -X GET "https://api.example.com/api/v1/users/usr_123" \
  -H "Authorization: Bearer YOUR_TOKEN"

Python

import requests

response = requests.get(
    "https://api.example.com/api/v1/users/usr_123",
    headers={"Authorization": "Bearer YOUR_TOKEN"}
)
print(response.json())

関連プロンプト

• アーキテクチャ決定記録（ADR）を作成するプロンプト
• バグレポートを作成するプロンプト
• コードレビューコメントを作成するプロンプト