すべてのプロダクト
Search
ドキュメントセンター

API Gateway:API定義のインポートとエクスポート

最終更新日:Jan 26, 2025

このトピックでは、OpenAPI Specification (OAS) 標準に基づいてAPI定義をインポートおよびエクスポートする方法と、Swagger準拠の拡張機能をインポートする方法について説明します。 これにより、APIサービスを効率的、安全かつ自動的に管理および保守できます。

OAS準拠のAPIのインポート

API Gatewayを使用すると、OpenAPI Specification (OAS) 2.0または3.0標準に準拠したAPI定義をインポートできます。 API Gatewayでは、OAS準拠の拡張機能をインポートすることもできます。 これにより、既存のAPIをAPI Gatewayにすばやく移行できます。 これらのAPIは、API Gatewayで変更せずに直接使用および管理できます。 具体的には:

  • OAS 2.0-complinant API定義とAPI Gateway API定義のパラメーター間のマッピング。

  • OAS 3.0-complinant API定義とAPI Gateway API定義のパラメーター間のマッピング。

  • OAS 2.0のインポート-API Gateway拡張を含む包括的なAPI定義

OASに基づくAPIのエクスポート

API Gatewayでは、OAS 2.0またはOAS 3.0標準に基づいてAPI定義をエクスポートできます。 これにより、柔軟なAPI管理と展開のために、アカウント、リージョン、さらにはプラットフォーム間でAPIデータを移行できます。 具体的には:

  • OAS準拠のAPIのエクスポート

    APIグループ全体または特定のAPIをエクスポートできます。

SwaggerファイルをインポートしてAPI Gateway拡張機能でAPIを作成

Swagger 2.0ファイルをインポートしてAPIを作成するには、API GatewayコンソールまたはImportSwagger操作を呼び出します。 具体的には:

  • Swaggerでサポートされている拡張機能: Swaggerは、ネイティブのOperationオブジェクトへの拡張機能をサポートします。 拡張機能は、認証、パラメータマッピング、およびバックエンドサービスのための機能を提供するために使用されます。

  • 互換性: SwaggerのパラメータータイプとAPI Gatewayのパラメータータイプの比較。

  • Swagger拡張機能の例: API GatewayのSwagger拡張機能の例。

  • 使用状況メモ: 機能を使用するときに注意を払う必要がある項目。