Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Impor file OpenAPI untuk memperbarui definisi API yang ada
Anda dapat mengimpor definisi API hanya untuk memperbarui API yang ada, tanpa mengubah konfigurasi titik akhir, serta variabel tahapan dan tahap, atau referensi ke kunci API.
Operasi impor-untuk-pembaruan dapat terjadi dalam dua mode: menggabungkan atau menimpa.
Ketika API (A) digabungkan ke lain (B), API yang dihasilkan mempertahankan definisi keduanya A dan B jika kedua API tidak memiliki definisi yang bertentangan. Ketika konflik muncul, definisi metode dari API penggabungan (A) akan mengesampingkan definisi metode yang sesuai dari API gabungan (). 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
Saat A digabungkanB, API yang dihasilkan menghasilkan metode berikut:
GET /a
yang kembali 200 dan 400 tanggapan, dan
POST /a
yang kembali 200 dan 206 tanggapan.
Menggabungkan API berguna ketika Anda telah menguraikan definisi API eksternal Anda menjadi beberapa bagian yang lebih kecil dan hanya ingin menerapkan perubahan dari salah satu bagian tersebut pada satu waktu. Misalnya, ini mungkin terjadi jika beberapa tim bertanggung jawab atas bagian API yang berbeda dan memiliki perubahan yang tersedia dengan tarif yang berbeda. Dalam mode ini, item dari API yang ada yang tidak ditentukan secara khusus dalam definisi yang diimpor dibiarkan saja.
Saat API (A) menimpa API (B) lain, API yang dihasilkan mengambil definisi dari API penimpaan ()A. Menimpa API berguna ketika definisi API eksternal berisi definisi lengkap API. Dalam mode ini, item dari API yang ada yang tidak ditentukan secara khusus dalam definisi yang diimpor akan dihapus.
penting
Saat Anda menggunakanmode=overwrite, seluruh definisi API diganti. Konfigurasi API apa pun yang tidak secara eksplisit disertakan dalam badan impor disetel ulang ke nilai defaultnya. Ini termasuk pengaturan seperti kebijakan keamanan, konfigurasi otorisasi, dan properti lainnya API-level .
Untuk mempertahankan konfigurasi yang ada, gunakanmode=merge, yang mempertahankan konfigurasi yang ada yang tidak ditentukan dalam badan impor. Jika Anda menggunakanmode=overwrite, pastikan bahwa definisi OpenAPI Anda mencakup semua konfigurasi API yang diinginkan, seperti ekstensi API Gateway.
Untuk menggabungkan API, kirimkan PUT permintaan kehttps://apigateway.. Nilai parameter <region>.amazonaws.com/restapis/<restapi_id>?mode=mergerestapi_id jalur menentukan API tempat definisi API yang disediakan akan digabungkan.
Cuplikan kode berikut menunjukkan contoh PUT permintaan untuk menggabungkan definisi OpenAPI API di JSON, sebagai payload, dengan API tertentu yang sudah ada di API Gateway.
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 definisi API lengkap dan menggabungkannya bersama-sama. Untuk perubahan kecil dan bertahap, Anda dapat menggunakan operasi pembaruan sumber daya.
Untuk menimpa API, kirimkan PUT permintaan kehttps://apigateway.. Parameter <region>.amazonaws.com/restapis/<restapi_id>?mode=overwriterestapi_id path menentukan API yang akan ditimpa dengan definisi API yang disediakan.
Cuplikan kode berikut menunjukkan contoh permintaan penimpaan dengan muatan definisi: JSON-formatted 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.
catatan
PUTOperasi itu idempoten, tetapi tidak atom. Itu berarti jika kesalahan sistem terjadi sebagian melalui pemrosesan, API dapat berakhir dalam keadaan buruk. Namun, mengulangi operasi berhasil menempatkan API ke status akhir yang sama seolah-olah operasi pertama telah berhasil.
