メインコンテンツまでスキップ

クイックスタート

この短い手順では、コアループを通します。仕様を開き、AI アシスタントで変更し、リクエストを送り、結果をドキュメントとして確認します。すべて同じ OpenAPI 文書を使います。

1. 仕様を開く​

クライアントを起動し、手元のソースで仕様を開きます。以下はすべて同じインポートフローでサポートされ、OpenAPI 3.2 へ自動的に変換またはアップグレードされます。

  • ディスク上の OpenAPI または Swagger ファイル（Swagger 2.0、OpenAPI 3.0 / 3.1 はアップグレード）。
  • Postman コレクション。
  • cURL コマンド。
  • Git リポジトリ。
  • 仕様を指す URL。

ファイルをワークスペースに直接ドラッグすることもできます。始めるものが何もない場合は、短い説明からアシスタントに初期スケルトンを作ってもらえます。

2. アシスタントにエンドポイントを追加してもらう​

チャットで必要なものを説明します。例:

製品のページネーション付きリストを返す GET /products エンドポイントを追加して。

アシスタントは文書を直接編集するのではなくパッチカードで応答します。カードには変更予定の操作と、影響を受けるパス・リソースが表示されます。レビューして適用または拒否を選びます。適用するまで文書には何も届きません。

「e コマース API を作って」のような広い要求では、アシスタントはまず明確化の質問をし、その後、一度に 2〜5 操作に絞ったパッチを提案します。

3. 1 つの操作をブレずに refine する​

操作を開き、その場で refine します。例えばクエリパラメータを追加したり、レスポンススキーマを拡張したりします。フォーカスモードでは、アシスタントは依頼したフィールドだけに触れる細かいパッチを生成し、その操作の他のすべてのフィールドを保持します。これにより、同じ API での繰り返しの編集が、既存の作業をブレさせたり上書きしたりするのを防ぎます。

4. 実際のリクエストを送る​

操作のリクエストワークスペースに切り替えて送信します。リクエストはローカルのメインプロセス経由で実行されます。レスポンス、ステータス、ヘッダー、タイミングが操作と並べて表示され、実行ごとに変わる値には環境と変数を使えます。

仕様の servers とアクティブな環境の両方にベース URL がなくてリクエストを構築できない場合、アプリは推測せず、ベース URL の入力を求めます。

5. ドキュメントを確認する​

ドキュメントを開くと、同じ仕様が読みやすい API ドキュメントとしてレンダリングされます。ビューアーはライブの文書を読むため、ドキュメントは今設計した内容と常に一致します。

6. 準備ができたらさらに進む​

これでコアループが完成です。残りのドキュメントでは各ワークスペースを詳しく説明します。