Geliştirme, hazırlık ve üretim trafiğini birbirinden izole etmek için API Gateway; TEST, PRE ve RELEASE olmak üzere üç yerleşik ortam sağlar. Ayrıca aynı API yapılandırmalarını farklı arka uç URL'lerine eşleyen özel ortamlar oluşturmanıza olanak tanır.
Ortamların çalışma şekli
API Gateway, her API isteğini hedef ortama göre belirli bir arka uç URL'sine yönlendirir. Aynı API yapılandırması her ortamda farklı bir arka uç URL'sini işaret edebilir. Bu sayede değişiklikler üretime alınmadan önce güvenli bir şekilde doğrulanır.
Ortamları kullanmak için aşağıdaki adımları tamamlayın:
(İsteğe bağlı) Özel bir ortam oluşturun: Üç yerleşik ortamın ötesinde ek ortamlar oluşturmak için API Gateway konsolunu kullanın.
Arka uç hizmetinizi yapılandırın: API isteklerinin doğru arka uca yönlendirilmesi için her ortamda farklı bir arka uç URL'si ayarlayın.
İstemcinizi yapılandırın: İstemciler belirli bir ortamı hedeflemelidir. Her ortam için ayrı bir alan adı bağlayın veya istemcilerin isteklerinde X-Ca-Stage başlığını göndermesini şart koşun.
Ortam oluşturma
API Gateway; TEST, PRE ve RELEASE adlı üç yerleşik ortam sunar. Bu ortamlar gereksinimlerinizi karşılamıyorsa özel bir ortam oluşturun.
Mevcut ortamları görüntülemek için API Gateway konsoluna giriş yapın.
-
Create Environment seçeneğine tıklayın. Create Environment iletişim kutusunda aşağıdaki alanları doldurun. Ortam adı ve takma adı genel olarak benzersiz olmalıdır.
Environment Name: 2–10 karakter; yalnızca büyük harfler ve rakamlar kullanılabilir; büyük harfle başlamalıdır.
Alias: Ortamın görünen adı. 2–50 karakter; harfler, rakamlar ve alt çizgi (_) kullanılabilir.
Description: Ortam hakkında kısa bir açıklama.
Ortamı oluşturmak için Confirm seçeneğine tıklayın.
Ortamları kullanma
Arka uç hizmeti için ortam URL'lerini yapılandırma
API arka uç uygulamalarınızı arka uç hizmetleri kullanarak yönetin ve her ortam için farklı bir URL yapılandırın. Kurulum talimatları için API'leri oluşturmak ve yönetmek için arka uç hizmeti kullanma konusundaki 1. ve 2. adımlara bakın.
API'leri bir ortama yayınlama
Bir arka uç hizmeti oluşturup yapılandırdıktan sonra istemcilerin çağırabilmesi için bir API oluşturun. API oluşturma ve hata ayıklama talimatları için API'leri oluşturmak ve yönetmek için arka uç hizmeti kullanma konusundaki 3., 4. ve 5. adımlara bakın. API'yi; TEST, PRE, RELEASE ve oluşturduğunuz tüm özel ortamlar dahil olmak üzere herhangi bir ortama yayınlayabilirsiniz.
Bir ortamı hedeflemek için X-Ca-Stage başlığını kullanma
Hata ayıklama sırasında API'nizi sistem tarafından sağlanan ikinci düzey alan adını veya X-Ca-Stage istek başlığını kullanarak test edebilirsiniz. API grubuna bağımsız bir alan adı bağladıysanız ve Environment parametresini Default (X-Ca-Stage) olarak ayarladıysanız istemciler belirli bir ortamı hedeflemek için X-Ca-Stage başlığını kullanabilir.
API'yi RELEASE ortamında çağırmak için X-Ca-Stage başlığını belirtmeyin.
API'yi PRE ortamında çağırmak için her istekte X-Ca-Stage: PRE başlığını ekleyin.
API'yi TEST ortamında çağırmak için her istekte X-Ca-Stage: TEST başlığını ekleyin.
API'yi özel bir ortamda çağırmak için X-Ca-Stage: environment name başlığını ekleyin; burada environment name yerine gerçek ortam adını yazın.
Bir ortama alan adı bağlama
İstemcilerin X-Ca-Stage başlığını belirtmeden API'leri çağırabilmesi için her ortama özel bir alan adı bağlayın. Bağımsız bir alan adını bir API grubuna bağlarken hedef ortamı seçin. Talimatlar için API çağrılarına izin vermek için özel bir alan adı bağlama konusuna bakın.
Alan adı bağlama işlemi, X-Ca-Stage başlığına göre önceliklidir. API Gateway, istemcinin gönderdiği X-Ca-Stage başlık değerinden bağımsız olarak istekleri bağlama yapılandırmasına göre yönlendirir.
Ortam silme
Mevcut ortamları görüntülemek için API Gateway konsoluna giriş yapın.
Silmek istediğiniz ortamı bulun ve Actions sütununda Delete seçeneğine tıklayın.
Yerleşik ortamlar silinemez.
İlişkili arka uç hizmetleri bulunan ortamlar silinemez.
Yayınlanmış API'leri içeren ortamlar silinemez.