Impor API file Open untuk memperbarui API definisi yang ada

Anda dapat mengimpor API definisi hanya untuk memperbarui yang sudah adaAPI, tanpa mengubah konfigurasi titik akhir, serta variabel tahapan dan tahap, atau referensi ke API kunci.

import-to-update Operasi dapat terjadi dalam dua mode: menggabungkan atau menimpa.

Ketika an API (A) digabungkan menjadi (B) lain, yang dihasilkan API mempertahankan definisi keduanya A dan B jika keduanya APIs tidak berbagi definisi yang saling bertentangan. Ketika konflik muncul, definisi metode penggabungan API (A) mengesampingkan definisi metode yang sesuai dari gabungan API (). B Misalnya, misalkan B telah menyatakan metode berikut untuk kembali 200 dan 206 tanggapan:

GET /a
POST /a

dan A mendeklarasikan metode berikut untuk kembali 200 dan 400 tanggapan:

GET /a

Ketika A digabungkan menjadiB, yang dihasilkan API menghasilkan metode berikut:

GET /a

yang kembali 200 dan 400 tanggapan, dan

POST /a

yang kembali 200 dan 206 tanggapan.

Menggabungkan an API berguna ketika Anda telah menguraikan API definisi eksternal Anda menjadi beberapa bagian yang lebih kecil dan hanya ingin menerapkan perubahan dari salah satu bagian tersebut sekaligus. Misalnya, ini mungkin terjadi jika beberapa tim bertanggung jawab atas bagian yang berbeda dari suatu API dan memiliki perubahan yang tersedia dengan tarif yang berbeda. Dalam mode ini, item dari yang ada API yang tidak ditentukan secara khusus dalam definisi yang diimpor dibiarkan saja.

Ketika a API (A) menimpa other API (B), yang dihasilkan API mengambil definisi dari overwriting API ()A. Menimpa an API berguna ketika API definisi eksternal berisi definisi lengkap dari sebuahAPI. Dalam mode ini, item dari yang sudah ada API yang tidak ditentukan secara khusus dalam definisi yang diimpor akan dihapus.

Untuk menggabungkanAPI, kirimkan PUT permintaan kehttps://apigateway.<region>.amazonaws.com/restapis/<restapi_id>?mode=merge. Nilai parameter restapi_id path menentukan API definisi API yang disediakan akan digabungkan.

Cuplikan kode berikut menunjukkan contoh PUT permintaan untuk menggabungkan OpenAPI API definisiJSON, sebagai payload, dengan yang sudah ditentukan API di Gateway. API

PUT /restapis/<restapi_id>?mode=merge
Host:apigateway.<region>.amazonaws.com
Content-Type: application/json
Content-Length: ...

An OpenAPI API definition in JSON 
        

Operasi pembaruan penggabungan mengambil dua API definisi lengkap dan menggabungkannya bersama-sama. Untuk perubahan kecil dan bertahap, Anda dapat menggunakan operasi pembaruan sumber daya.

Untuk menimpaAPI, kirimkan PUT permintaan kehttps://apigateway.<region>.amazonaws.com/restapis/<restapi_id>?mode=overwrite. Parameter restapi_id path menentukan API yang akan ditimpa dengan definisi yang disediakanAPI.

Cuplikan kode berikut menunjukkan contoh permintaan penimpaan dengan muatan definisi yang diformat: JSON OpenAPI

PUT /restapis/<restapi_id>?mode=overwrite
Host:apigateway.<region>.amazonaws.com
Content-Type: application/json
Content-Length: ...

An OpenAPI API definition in JSON 
            
        

Ketika parameter mode kueri tidak ditentukan, penggabungan diasumsikan.