生成AIプロンプト研究所チャプロ
  • エンジニア検定
  • 記事
  • セミナー
  • プロンプト
  • 便利サービス
無料登録
menu
ホームプロンプトAPI仕様書の自動生成プロンプト
通常システム開発

API仕様書の自動生成プロンプト

根津 知則

WEBAPI仕様書作成支援プロンプト

API設計に関する基本知識を持つシステムエンジニアが、詳細なWEBAPI仕様書を作成するための支援を行う。

このプロンプトは、システムエンジニアがWEBAPI仕様書を作成する際に必要な情報を収集し、標準フォーマットに基づいてドキュメントを作成します。具体的には、API名、機能概要、エンドポイントURL、HTTPメソッド、リクエストパラメーター、レスポンスフォーマット、認証情報を含めるよう指示し、統一されたデータフォーマットでの設計をサポートします。

プロンプト本文


#前提条件
- タイトル:WEBAPI仕様書作成プロンプト
- 依頼者条件:API設計に関する基本知識を有するシステムエンジニア。
- 前提知識:API仕様書の標準フォーマットとその構成要素についての理解。
- 目的と目標:WEBAPI仕様書を作成し、クライアントとのコミュニケーションを円滑に行うことを目的とする。

#実行指示
以下の情報を基に、詳細なWEBAPI仕様書を作成してください。{API名}の{機能概要}を含めて、{エンドポイントURL}、{リクエストパラメーター}、{レスポンスパラメーター}、および{認証情報}を詳細に記述してください。一貫したデータフォーマットで標準的な仕様を満たすよう設計してください。
{出力フォーマット}を参考にして出力してください。

API名 ="

"
機能概要 ="

"
エンドポイントURL ="

"
リクエストパラメーター ="

"
レスポンスパラメーター ="

"
認証情報 ="

"

出力フォーマット ="
# API設計書:[API名]

## 1.機能概要
[機能概要
]
## 2.API仕様
- エンドポイントURL
- HTTPヘッダー
- HTTPメソッド
## 3.パラメータ
### 3.1.入力パラメータ
|No|パラメータ名|型|必須|説明|
|---|---|---|---|---|

### 3.2.出力パラメータ
#### 成功時(200 OK)
|No|パラメータ名|型|説明|
|---|---|---|---|
#### 失敗時(400 Bad Request) ← 400以外も適宜追加
|No|パラメータ名|型|説明|
|---|---|---|---|

### 3.3.エラーコード一覧
|No|HTTPステータス|エラーコード|説明|
|---|---|---|---|```

### 3.4 パラメータサンプル
#### 入力パラメータ

#### 入力パラメータ

"

スタイルとトーン =
形式的で明確なトーン

#補足:
指示の再確認は不要です。
結論やまとめは不要です。
自己評価は不要です。
{出力フォーマット}のフォーマット形式を厳守してくだい。
API名
機能概要
エンドポイント
リクエストパラメータ
レスポンスパラメータ
認証情報
運営会社
利用規約
プロンプトエンジニア一覧
プロンプトエンジニア育成講座
©2025 生成AIプロンプト研究所「チャプロ」 All rights reserved.