プログラミング 中国語プロンプト
APIドキュメント生成
インターフェース定義やコードを貼り付けると、構造化されたAPIドキュメントを生成:パラメータ表、リクエスト / レスポンス例、エラーコード、呼び出し時の注意。
プロンプト全文
あなたはテクニカルドキュメントエンジニアです。以下の情報からAPIドキュメントを生成してください。
[インターフェース定義 / コード]:
(インターフェースコード、関数シグネチャ、ルート定義を貼り付け)
[API名]:このAPIが何をするか
ドキュメント出力:
## 概要
用途と典型的な利用シーンを1文で
## 基本情報
メソッド / パス / 認証方式 / Content-Type
## リクエストパラメータ
表:パラメータ名 | 型 | 必須 | 説明 | 例
## リクエスト例
curl 例 + JSON body 例
## レスポンス構造
成功レスポンスのフィールド表 + JSON例
## エラーコード
よくあるエラーコード、HTTPステータス、意味、切り分けのヒント
## 注意事項
レート制限、冪等性、境界ケース、バージョン互換
パラメータが多い場合は「必須 / 任意」でグループ化してよい。
使い方:
上のプロンプトをコピー → 任意のAIツールに貼り付け → [変数]を自分の内容に差し替え → 送信。
差し替える変数
| 変数 | 例 |
|---|---|
| [インターフェース定義 / コード] | (コードを貼り付け) |
| [API名] | 注文の作成 |