Web制作のAPIドキュメント作成ガイドプロンプト

#前提条件:
- タイトル: Web制作のAPIドキュメント作成ガイド
- 依頼者条件: Web制作のAPIドキュメントを正確かつ効率的に作成したいエンジニア
- 制作者条件: APIの設計、Web開発、およびドキュメント作成に関する深い知識と経験
- 目的と目標: APIの使用者が容易に理解できる、体系的かつ詳細なAPIドキュメントを作成すること
- リソース: API仕様書、エンドポイントのリスト、使用例、認証情報、エラーハンドリングガイドライン
- 評価基準: API利用者がドキュメントを使って問題なくAPIを実装できること
- 明確化の要件:
1. APIの全エンドポイントとその機能を網羅する
2. 認証方法と必要なリクエストヘッダーの詳細を含める
3. 各エンドポイントのリクエスト/レスポンス例を具体的に記載する
4. エラーハンドリングに関する説明を充実させる
5. 言語・表現は明確で曖昧さを避ける
6. 更新履歴を管理し、変更内容を適切に反映する

# 実行指示:
{web制作者}の情報を基に、
{APIの名称}の全{エンドポイント一覧}を網羅し、
各{リクエストメソッド}に対するリクエストとレスポンスの詳細な例を提示し、
{レスポンスボディ}を曖昧でない言葉で明確に説明し、
{認証方法}を含めた詳細なドキュメントを構造化された
スタイルかつ、親しみやすいトーンで概要形式（Overview Format）で作成してください。
{参考フォーマット}を参考に作成してください。


web制作者="
**性格:**
- 詳細にこだわり、精密な作業を心掛ける傾向がある。
- 問題解決に対して熱心で、困難な技術的課題にも果敢に挑む。
- 継続的な学習と自己改善に興味があるため、常に最新の技術トレンドを追いかけている。

**対象の悩み:**
- コードの保守性とスケーラビリティを確保するための最適な設計方法について常に検討している。
- クライアントの要求と技術的な制限のバランスを取ることが難しいことがある。
- プロジェクトの締め切りと品質の両方を満たすことの圧力。

**興味・関心:**
- 新しいプログラミング言語やフレームワークを学ぶことに興味が深い。
- ユーザーインターフェース（UI）とユーザーエクスペリエンス（UX）の改善に関心がある。
- オープンソースプロジェクトへの参加や技術コミュニティでの活動。

**特徴的な行動:**
- コードのリファクタリングと最適化を定期的に行い、効率的なシステムを維持するための努力を惜しまない。
- チームメンバーや他部署の人々と積極的にコミュニケーションを取り、プロジェクトの進行をスムーズにする。
- 継続的な技術のアップデートとトレーニングに時間を割いている。
"


APIの名称="

"
エンドポイント一覧="

"
リクエストメソッド="

"
レスポンスボディ="

"
認証方法="

"


参考フォーマット="
## 【{APIの名称}ドキュメント】

---

### 【1. 概要】
**{APIの名称}**は、特定のサービスやデータを提供するためのAPIです。このAPIを使用することで、**サービスの説明**に関するデータを取得または送信できます。APIはREST形式で提供され、標準的なHTTPリクエストを介して利用可能です。

### 【2. 認証】
**｛APIの名称｝**の使用には認証が必要です。認証は**認証方法**で行われ、以下の例のように設定してください：

- **例：APIキー認証**
リクエストヘッダーにAPIキーを含めてください：

```
Authorization: Bearer {API_KEY}
```

認証が成功すると、APIへのアクセスが許可されます。認証に失敗した場合は、401 Unauthorizedエラーが返されます。

### 【3. エンドポイント一覧】
以下に**API名称**の主要エンドポイントを示します。

#### 【3.1. `/example-endpoint`】
- **説明**:
- **メソッド**:
- **リクエストパラメータ**:
- `id` (必須): 取得対象のリソースID。
- **レスポンス例**:

#### 【3.2. `/example-create`】
- **説明**: 新しいリソースを作成します。
- **メソッド**: `POST`
- **リクエストボディ**:
- `name` (必須): 作成するリソースの名前。
- `description` (任意): リソースの説明。
- **レスポンス例**:

### 【4. エラーハンドリング】
APIは、エラーが発生した場合に適切なHTTPステータスコードとエラーメッセージを返します。以下は一般的なエラーハンドリングの例です。

エラーレスポンス例:


### 【5. 更新履歴】
APIのバージョンやエンドポイントの変更は、以下のように記録します。利用者は、常に最新のドキュメントを参照して最新のAPI仕様を確認してください。

- **v1.0.0** - 初回リリース
- **v1.1.0** - 新エンドポイント `/example-create` を追加
- **v1.1.1** - `/example-endpoint` のレスポンスに新しい属性を追加

---
"