AI Compare Ninja AI Compare Ninja

AIツールを比較。プロンプトとスキルを活用。
言語
JA

すぐに使えるAPIリファレンスを書く

コードと例から、エラーコードと動く呼び出し例を備えたエンドポイント別リファレンスを書くプロンプト。お好きなAIツールに貼り付けると、AIがAPIリファレンスを書く。

テーマ
アプリ・プロトタイプ
種類
プロンプト
レベル
中級
所要時間
約10分

結果はツール、モデル、入力内容によって変わります。

結果のプレビュー

例：当サイトの編集部が書いたもので、実際のAIの出力ではありません。

## POST /orders 注文を作成します。 | 項目 | 型 | 必須 | 補足 | | customer_id | 文字列 | はい | GET /customers から取得 | | items | リスト | はい | 1件以上 | | coupon | 文字列 | いいえ | 大文字 | エラー: 409 = クーポン使用済み → クーポンなしで再送 未解決の質問: 1分あたり100回の上限はキーごとか、アカウントごとか？

入力する

入力した内容はこのブラウザ画面の中だけにとどまります。当サイトが保存・送信することはありません。

どのAPIですか？
何がありますか？
誰が読みますか？

あなたのプロンプト

これはAIへの指示文で、まだ完成品ではありません。

このプロンプトが使えるツール

このプロンプトに向いているAIツール：

使い方

  1. 項目を入力するか、候補をタップします。氏名、住所などの個人情報は入れません。
  2. 完成したプロンプトをお好きなAIツールに貼り付けます。
  3. APIを知らない人にリファレンスだけを渡してください。質問せずに最初の呼び出しに成功すれば、良いリファレンスです。

なぜうまくいくのか

リファレンスがつまずくのは、エンドポイントの抜けよりも、エラーコードの欠落、必須項目のあいまいさ、動かない例が原因です。エンドポイントごとの決まった構成と、推測ではなく未解決の質問として残すことで信頼できるものになります。

ヒント

  • 資料をAIツールに入れる前に、例のキー、トークン、顧客データをプレースホルダーに置き換えてください。

こちらもおすすめ

当サイトのプロンプトは、仕事を含めて自由に使えます。独自のコレクションとして公開することはご遠慮ください。AIの出力については保証しません。必ずご自身で確認してください。 利用規約