プログラマーのAPI仕様書を作るためのプロンプト

#前提条件:
- タイトル: プログラマーの理解しやすいAPI仕様書を作成するプロンプト
- 依頼者条件: API仕様書の作成を効率よく行いたいプログラマー
- 前提知識: API設計やドキュメント作成に関する基本的な知識
- 目的と目標: API仕様書を正確かつ簡潔に作成し、開発者間での理解を促進する


# 実行指示
{対象者}に向けて
{対象API}を基に、
{使用言語}を用いて、
{認証方式}を考慮した、
{パラメータ制約}を明確に定義し、
{レスポンス形式}を簡潔に記述し、
見出しやセクションごとに明確な分類を行うスタイルで、読み手が具体的な行動を取りやすい指示口調で
API仕様書を表形式で箇条書きで段落名をつけて作成してください。
{参考フォーマット}を参考に書いてください。

対象API="

"
使用言語="

"
認証方式="

"
パラメータ制約="

"
レスポンス形式="

"


{対象プロジェクト}　｛対象API｝｛使用言語｝{認証方式}　｛レスポンスコードの詳細｝
｛利用するデータベース｝｛パラメータ制約｝｛APIのバージョン｝｛レスポンス形式｝｛タイムアウト設定やトライポリシー｝を基に理解しやすいAPI仕様書をMarkdown形式で書いてください。


対象者="
ECサイトのプログラマーのプロファイル
依頼者条件:プロファイル情報を効果的にまとめたいと考えている人。
制作者条件: 人物のプロファイルを正確に生成できる能力を持つ人。
目的と目標: プロファイルをAIを使って効率的に生成すること。
人物情報：ECサイトを作っているプログラマー
"

対象API="ユーザー管理API"
使用言語="Python"
認証方式="OAuth2.0"
パラメータ制約="ユーザーIDは数値、必須"
レスポンス形式="JSON形式"
-
-

参考フォーマット="
```markdown
# ○○API仕様書

## 概要

## 使用技術と設定

## リクエストとレスポンス仕様

### エンドポイント一覧

### リクエスト例とパラメータ

#### **GET /api/v1/users/{id}**

#### **POST /api/v1/users**

## レスポンスコード詳細

## データベース設計

## 注意事項
1. すべてのエンドポイントで認証が必須です。
2. 不適切なリクエストがエラーコードを引き起こす場合、エラーメッセージを解析して修正してください。
3. タイムアウトやリトライポリシーに基づく実装を行い、通信失敗時の処理を適切に設計してください。
```