この OpenAPI ツールの機能
フロントエンドの作業はバックエンドが準備される前に開始され、既に仕様があるAPIのタイプを手書きすることは無駄な作業です。JSONやYAMLで OpenAPI 3.xまたは Swagger 2.0のドキュメントを貼り付けると、このツールは3つのことを生成します。ブラウザで生成されるのでプライベートや内部APIの仕様はアップロードされません
使い方
- 仕様を貼り付け、ファイルをアップロードします。JSON と YAML の両方が受け入れられます。
- エンドポイントリストは、各操作の方法と経路を表示します。
- 模擬データタブを開いて、スケーマの例、フォーマット、数値から構築されたサンプル応答を見るために操作を選択します。
components/schemas(またはSwagger 2のdefinitions) から生成されたインターフェースでは TS型に切り替える。- TSクライアントに切り替えて、プロジェクトにコピーしてください。
模倣がどのように生成されるか
exampleとexamplesの値が常に勝っていますenumは最初の値を選び、defaultは尊重されます。- 文字列形式は、
email、uuid、date-time、uri、ipv4などの妥当な値を生成します。 name、priceまたはcreatedAtは現実的に見えます。$ref、allOf、oneOfとanyOfは解消され、再帰的な参照は安全に切断される。- 操作ごとに決定的なので、リフレッシュごとに変化しません。
生成されたクライアントを使用する
クライアントは、入力されたパスパラメータ、クエリパラメータ、リクエストボディで、入力された応答を返して、BASE_URL定数と1つの非同期関数を操作ごとに輸出し、その operationId (または方法と経路が欠落した場合) により命名する。fetchに依存しているのでブラウザ Node 18+、Deno、Bunでも動作します