Felo
APIの型・OpenAPIスキーマ作成AI
APIの型・OpenAPIスキーマ作成AIとは？
APIの型・OpenAPIスキーマ作成を、共有された条件に合わせて行います。OpenAPIスキーマ・仕様点検を、入力の条件に合わせて行います。 提供された素材と希望条件から、結果と確認すべき点をまとめます。まず下の入力例で試してみてください。
APIの型・OpenAPIスキーマ作成AIは、作業のテーマ、元の文章や素材、希望する条件と出力形式から作業を進めるための対話型アシスタントです。何を入力すればよいか迷った時は、下の入力例をそのまま貼って試せます。手元にある事実と、これから決めたい条件を分けて伝えると、初稿の修正もしやすくなります。
APIの型・OpenAPIスキーマ作成AIでできること
- API仕様、操作、認証方式、例を読み取る。
- 公開してよい情報だけでOpenAPI YAMLまたはJSONを作る。
- 必須項目、型、パス、ステータスとサンプルを点検する。
- 未確認エンドポイントや認証仕様を捏造せず、不足を残す。
使い方
- テーマと元の文章・数値・素材を共有してください。ファイルや画像を添付した場合は「開始」と入力します。
- 希望する件数、長さ、形式、対象者があれば添えてください。未定の条件は未定のままで構いません。
- 結果を見て、変更したい箇所と条件を指定します。対話やクイズでは、一問への回答後に次へ進みます。
入力例と利用場面
そのまま試せる入力例
架空APIです。GET /books、クエリlimitは整数1から100で既定10、200応答はid整数とtitle文字列を持つ配列。認証なし。OpenAPI3.0のYAML例と不足条件を作ってください。
この例で返す内容
指定パスと型のスキーマ。不明な本番URLを作らない。
条件を変えて使う時
初稿の用途を変えたい時は、対象者、長さ、語調、必要な項目を指定してください。元の事実を保ちながら短くする場合と、新しい情報を追加する場合を分けると、どこを確認するべきかが分かりやすくなります。元の資料にない事実・数値・素材を作らない。
使いやすい結果を得るコツ
固有名詞、日付、数量、元資料の範囲など、変更してはいけない条件を最初に示してください。比較や修正では、良いと感じた部分と変えたい部分を具体的に伝えると、次の案に反映できます。
提供されていない価格や実績、誰かの発言を補って書くことはありません。入力例は動かし方を説明する架空の素材であり、その数値や設定が実際の利用者に引き継がれることはありません。
よくある質問
何を入力できますか？
作業のテーマ、元の文章や素材、希望する条件と出力形式を使います。文章を貼り付けるほか、内容を取得できる添付資料を共有できます。読めなかった素材はその旨を示します。URLの本文を取得できない場合は、必要な箇所の文章も共有してください。
情報が足りなくても始められますか？
テーマが分かれば、任意の条件の不足だけで止めずに進みます。計算対象の元データなど、作業そのものに必須の資料がない場合だけ一つ伺います。仮定と未確認は結果に残し、数字を想像で埋めません。
ChatGPTなどの一般的なAIチャットとの違いは？
APIの型・OpenAPIスキーマ作成AIは、今回の作業に必要な手順と確認項目をあらかじめ整理しています。特に「完成した結果」から「調整できる点」までを一つの対話で進められるようにしています。外部サービスの管理画面、継続同期、アカウント操作まで再現するものではありません。
生成や取得に失敗した場合は？
作成できた部分を先に示し、どの処理が未完了かを説明します。画像や動画、ファイルは実際に生成されたものだけを表示します。再試行する時は、変更したい範囲を短く指定してください。