既存のルートからAPI仕様の下書きを作る
既存のルートと例から、未解決の点の一覧付きでOpenAPIの下書きを作るテンプレートです。お好きなAIツールに貼り付けると、AIがAPI仕様の下書きを書く。
- テーマ
- アプリ・プロトタイプ
- 種類
- テンプレート
- レベル
- 中級
- 所要時間
- 約15分
結果はツール、モデル、入力内容によって変わります。
結果のプレビュー
例：当サイトの編集部が書いたもので、実際のAIの出力ではありません。
paths: /orders/{id}: get: summary: 注文を1件取得 responses: "200": { $ref: "#/components/schemas/Order" } "404": { description: 注文が見つからない } 未解決の点: - status: ここでは「open」、/ordersでは「pending」 - /refundsのエラー形式が不明
入力する
入力した内容はこのブラウザ画面の中だけにとどまります。当サイトが保存・送信することはありません。
どのAPIですか？
- 注文と商品を扱うショップのバックエンド
- ユーザーアカウントの社内サービス
- 個人プロジェクトの小さなREST API
- 取引先向けのAPI
- Webhookのエンドポイント
何を貼り付けられますか？
- コード内のルート定義
- リクエストとレスポンスの例
- 古いWikiページ
- 個人データを含まない実際の呼び出しログ
- これらの組み合わせ
仕様は何に使いますか？
- 取引先向けのドキュメント
- クライアントの自動生成
- ビルド時の契約チェック
- 新しい開発者のオンボーディング
- まずは全体の把握
あなたのプロンプト
プロンプトを編集しました。上の入力欄を変えても、もう上書きされません。
これはAIへの指示文で、まだ完成品ではありません。
このプロンプトが使えるツール
このプロンプトに向いているAIツール：
使い方
- 項目を入力するか、候補をタップします。氏名、住所などの個人情報は入れません。
- 完成したプロンプトをお好きなAIツールに貼り付けます。
- 例は架空の値で貼り付けてください。本物のトークンや顧客データは材料に入れないでください。
なぜうまくいくのか
コードから起こした仕様は、動いている間は誰も気づかない穴を見せてくれます。文書化されていないエラー、二つの意味を持つ項目、パターンから外れたルートなどです。
ヒント
- 公開する前に、動いているAPIと下書きを照らし合わせてください。実際と違う仕様は、ないよりも悪い結果を招きます。