コンテンツへスキップ
Claude Opus 4.54.8 · 5,600 回使用

API ドキュメント生成

コードやエンドポイント記述から明確で構造化された API ドキュメントを生成。

プロンプト本文

以下のエンドポイントの API ドキュメントを生成してください。

エンドポイント:[URL とメソッド]
認証:[タイプ]
リクエストボディ:[スキーマまたは例]
レスポンス:[スキーマまたは例]

含める項目:
1. 簡潔な説明
2. リクエストパラメータ(パス、クエリ、ボディ)
3. ステータスコード付きレスポンス形式
4. リクエスト/レスポンス例
5. エラーコードと処理メモ

OpenAPI/Swagger 統合に適した Markdown 形式で。

使い方

プロンプトをコピーし、[角括弧のプレースホルダー] を自分の内容に置き換えて、いつもの AI ツールに貼り付けてください。タスクに合わせてトーンや範囲を調整しましょう。

モデル
Claude Opus 4.5
評価
4.8 / 5
API ドキュメントドキュメント開発者

関連プロンプト