Mengatur API basePath properti Terbuka - APIGerbang Amazon
AbaikanPrependSplit

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Mengatur API basePath properti Terbuka

Di Open API 2.0, Anda dapat menggunakan basePath properti untuk menyediakan satu atau beberapa bagian jalur yang mendahului setiap jalur yang ditentukan dalam properti. paths Karena API Gateway memiliki beberapa cara untuk mengekspresikan jalur sumber daya, API fitur Impor menyediakan opsi berikut untuk menafsirkan basePath properti selama import: ignore, prepend, dan split.

Di OpenAPI 3.0, basePath bukan lagi properti tingkat atas. Sebagai gantinya, API Gateway menggunakan variabel server sebagai konvensi. APIFitur Impor menyediakan opsi yang sama untuk menafsirkan jalur dasar selama impor. Jalur dasar diidentifikasi sebagai berikut:

  • Jika API tidak mengandung basePath variabel apa pun, API fitur Impor memeriksa server.url string untuk melihat apakah itu berisi jalur di luar"/". Jika ya, jalur itu digunakan sebagai jalur dasar.

  • Jika hanya API berisi satu basePath variabel, API fitur Impor menggunakannya sebagai jalur dasar, bahkan jika itu tidak direferensikan diserver.url.

  • Jika API berisi beberapa basePath variabel, API fitur Impor hanya menggunakan yang pertama sebagai jalur dasar.

Abaikan

Jika API file Open memiliki basePath nilai /a/b/c dan paths properti berisi /e dan/f, berikut POST atau PUT permintaan: 

POST /restapis?mode=import&basepath=ignore

PUT /restapis/api_id?basepath=ignore

menghasilkan sumber daya berikut diAPI:

  • /

  • /e

  • /f

Efeknya adalah memperlakukan basePath seolah-olah tidak ada, dan semua API sumber daya yang dideklarasikan disajikan relatif terhadap host. Ini dapat digunakan, misalnya, ketika Anda memiliki nama domain khusus dengan API pemetaan yang tidak menyertakan Jalur Dasar dan nilai Tahap yang mengacu pada tahap produksi Anda.

catatan

APIGateway secara otomatis membuat sumber daya root untuk Anda, meskipun tidak secara eksplisit dideklarasikan dalam file definisi Anda.

Ketika tidak ditentukan, basePath mengambil secara ignore default.

Prepend

Jika OpenAPI file memiliki basePath nilai /a/b/c dan paths properti berisi /e dan/f, berikut POST atau PUT permintaan: 

POST /restapis?mode=import&basepath=prepend

PUT /restapis/api_id?basepath=prepend

menghasilkan sumber daya berikut diAPI:

  • /

  • /a

  • /a/b

  • /a/b/c

  • /a/b/c/e

  • /a/b/c/f

Efeknya adalah memperlakukan basePath sebagai menentukan sumber daya tambahan (tanpa metode) dan menambahkannya ke kumpulan sumber daya yang dideklarasikan. Ini dapat digunakan, misalnya, ketika tim yang berbeda bertanggung jawab atas bagian yang berbeda dari sebuah API dan basePath dapat merujuk lokasi jalur untuk API bagian masing-masing tim.

catatan

APIGateway secara otomatis membuat sumber daya perantara untuk Anda, meskipun tidak dinyatakan secara eksplisit dalam definisi Anda.

Split

Jika OpenAPI file memiliki basePath nilai /a/b/c dan paths properti berisi /e dan/f, berikut POST atau PUT permintaan: 

POST /restapis?mode=import&basepath=split

PUT /restapis/api_id?basepath=split

menghasilkan sumber daya berikut diAPI:

  • /

  • /b

  • /b/c

  • /b/c/e

  • /b/c/f

Efeknya adalah memperlakukan bagian jalur paling atas,/a, sebagai awal dari setiap jalur sumber daya, dan untuk membuat sumber daya tambahan (tanpa metode) di dalam API dirinya sendiri. Ini bisa, misalnya, digunakan ketika a adalah nama panggung yang ingin Anda ekspos sebagai bagian dari AndaAPI.