APIFuse

スキーマバンドル

APIFuse のスキーマバンドル artifact を使って、型付きのサーバー側連携を構築します。

スキーマバンドル

スキーマバンドルは、1 つの provider operation の contract をまとめたものです。API リファレンスに表示されるものと同じ schema で、サーバー側アプリケーションが gateway input と response を検証するのに役立ちます。

含まれる artifact

  • Input / output JSON Schema
  • OpenAPI operation fragment
  • TypeScript の input / output type
  • Zod の input / output schema
  • Pydantic v2 の input / output model
  • Request / response example
  • 認証 mode と関連要件
  • artifactVersionschemaHashbundleHashtargetArtifactHash などの version と hash field

変更検知

bundle hash が変わった場合は、operation contract を確認し、本番コードで新しい形に依存する前に型付き連携を更新してください。