Topik ini menjelaskan cara mengimpor dan mengekspor definisi API berdasarkan standar OpenAPI Specification (OAS) serta cara mengimpor ekstensi yang sesuai dengan Swagger. Ini membantu Anda mengelola dan memelihara layanan API secara efisien, aman, dan otomatis.
Impor API yang sesuai dengan OAS
API Gateway memungkinkan Anda mengimpor definisi API yang mengikuti standar OpenAPI Specification (OAS) 2.0 atau 3.0. API Gateway juga mendukung impor ekstensi yang sesuai dengan OAS. Hal ini memudahkan migrasi API yang sudah ada ke API Gateway. API tersebut dapat digunakan dan dikelola di API Gateway tanpa modifikasi tambahan. Secara khusus:
Pemetaan antara parameter dalam definisi API yang sesuai dengan OAS 2.0 dan definisi API API Gateway.
Pemetaan antara parameter dalam definisi API yang sesuai dengan OAS 3.0 dan definisi API API Gateway.
Impor definisi API yang sesuai dengan OAS 2.0 yang mencakup ekstensi API Gateway.
Ekspor API berdasarkan OAS
API Gateway memungkinkan Anda mengekspor definisi API berdasarkan standar OAS 2.0 atau OAS 3.0. Dengan cara ini, Anda dapat memigrasikan data API lintas akun, wilayah, atau bahkan platform untuk manajemen dan penyebaran API yang fleksibel. Secara khusus:
Ekspor API yang sesuai dengan OAS.
Anda dapat mengekspor seluruh grup API atau API tertentu.
Impor file Swagger untuk membuat API dengan ekstensi API Gateway
Anda dapat mengimpor file Swagger 2.0 untuk membuat API di konsol API Gateway atau dengan memanggil operasi ImportSwagger. Secara khusus:
Ekstensi yang didukung oleh Swagger: Swagger mendukung ekstensi terhadap Operation Object aslinya. Ekstensi digunakan untuk menyediakan fitur autentikasi, pemetaan parameter, dan tujuan layanan backend.
Kompatibilitas: Perbandingan antara tipe parameter di Swagger dan di API Gateway.
Contoh ekstensi Swagger: Contoh ekstensi Swagger untuk API Gateway.
Catatan penggunaan: Hal-hal yang perlu diperhatikan saat menggunakan fitur ini.