API Gateway'de arka uç hizmeti olarak EventBridge kullanan bir API oluşturun ve yayımlayın, ardından AppCode kimlik doğrulamasını kullanarak bu API'yi çağırın.
Genel Bakış
Arka uç hizmeti olarak EventBridge kullanan bir API oluşturmak ve yayımlamak için aşağıdaki adımları sırayla tamamlayın:
Arka uç hizmeti oluşturma
API grubu oluşturma
API oluşturma
Uygulama oluşturma ve uygulamaya API çağrısı yapma izni verme
API'yi hata ayıklama
API'yi çağırma
Ön Koşullar
EventBridge hizmeti etkinleştirilmiş ve özel bir olay veri yolu oluşturulmuş olmalıdır. Daha fazla bilgi için bkz. Özel olay veri yollarını yönetme.
Adım 1: Arka uç hizmeti oluşturma
API Gateway konsolu üzerinde oturum açın. Sol gezinme bölmesinde Manage APIs > Backend Services seçeneğini belirleyin.
Sayfanın sağ üst köşesinde Create Backend Service düğmesini tıklayın. Açılan iletişim kutusunda arka uç hizmetinin adını girin, Tür olarak EventBridge seçeneğini belirleyin ve Confirm düğmesini tıklayın.
Backend Services sayfasında oluşturduğunuz arka uç hizmetini bulun ve İşlemler sütununda Configure Backend Service and View Associated APIs seçeneğini belirleyin.
Production sekmesini tıklayın ve Temel Bilgiler bölümünün sağ üst köşesindeki Create düğmesini tıklayarak Production ortamı için arka uç hizmetini yapılandırın. Bir API'yi Production ortamına yayımlamadan önce arka uç hizmetini bu ortamda yapılandırmanız gerekir.
Define Backend Service sayfasında EventBridge konsolunda oluşturduğunuz bir olay veri yolunu seçin.
Seçtiğiniz olay veri yolu ile API Gateway örneğiniz aynı bölgede bulunuyorsa, dahili ağ üzerinden bir API çağırdığınızda API Gateway olayı olay veri yoluna gönderir. Bu örnekte hem olay veri yolu hem de API Gateway örneği Çin (Hangzhou) bölgesindedir. Parametreleri ayarladıktan sonra Yayımla düğmesini tıklayın.
Adım 2: API grubu oluşturma
API'ler API grupları içinde yönetilir. API oluşturmadan önce bir API grubu oluşturmanız gerekir.
API Gateway konsolunun sol gezinme bölmesinde Manage APIs > API Groups seçeneğini belirleyin. Sayfanın sağ üst köşesinde Create Group düğmesini tıklayın. Açılan iletişim kutusunda bir örnek seçin, bir grup adı girin ve temel bir yol ayarlayın. API grubu, kullandığınız olay veri yolu ile same region içinde bulunmalıdır.
API grubu oluşturulduktan sonra API Groups sayfasında görünür. Grup ayrıntıları sayfasına gitmek için grup adını tıklayın; burada etki alanı adı bağlayabilir, temel bilgileri değiştirebilir ve örnek türünü değiştirebilirsiniz.
API Gateway, API grubuna otomatik olarak bir public second-level domain name atar. Bu etki alanı adı yalnızca hata ayıklama ve test amaçlıdır. Bu etki alanı adını kullanarak API çağrıları yaparsanız, Çin anakarası dışındaki bölgelerde günde 100 çağrı ve Çin anakarasındaki bölgelerde günde 1,000 çağrı yapabilirsiniz. Bir API grubu oluşturduktan sonra an independent domain name bağlamanızı öneririz. Bu örnekte varsayılan ikinci düzey etki alanı adı kullanılmıştır.
Adım 3: API oluşturma
API Gateway konsolunun sol gezinme bölmesinde Manage APIs-APIs seçeneğini belirleyin. Sayfanın sağ üst köşesinde Create API düğmesini tıklayın.
API için temel bilgileri yapılandırın.
API grubu, ad, kimlik doğrulama yöntemi, tür ve açıklama dahil olmak üzere API için temel bilgileri yapılandırın. Bu örnekte Grup parametresi oluşturulan API grubuna, AppCode Kimlik Doğrulaması parametresi ise Enable AppCode Authentication (Header & Query) değerine ayarlanır. Diğer parametreleri gerektiği gibi ayarlayın ve İleri düğmesini tıklayın.
API için istek bilgilerini yapılandırın.
Bir tarayıcı, mobil uygulama veya iş sistemi gibi bir istemcinin API için istek gönderme şeklini tanımlayın. İstek Türü, Protokol, İstek Yolu, HTTP Yöntemi, İstek Modu ve istek parametrelerini belirtin, ardından İleri düğmesini tıklayın. Bu örnekte İstek Modu parametresi Pass-through olarak ayarlanır. Bu, API Gateway'in API isteklerini işlemeksizin doğrudan EventBridge'e iletmesi anlamına gelir.
API için arka uç hizmeti bilgilerini yapılandırın.
Arka uç hizmeti türünü, URL'yi ve parametre eşlemesini yapılandırın. Bu örnekte Yapılandırma Modu için Use Existing Backend Service seçeneği, Arka Uç Hizmeti Türü için EventBridge seçeneği belirlenir ve Arka Uç Hizmeti açılır listesinden oluşturduğunuz arka uç hizmeti seçilir. İleri düğmesini tıklayın.
Arka uç hizmeti olarak EventBridge kullanan bir API oluştururken yalnızca mevcut bir arka uç hizmetini seçebilirsiniz. Arka uç hizmetini özelleştiremezsiniz.
API için yanıtları tanımlayın.
API çağrılarının API'yi anlamasına yardımcı olacak API belgeleri oluşturmak için yanıt bilgilerini yapılandırın. Örnek bir başarılı yanıt ve örnek bir başarısız yanıt tanımlayabilirsiniz. Bu örnekte bu adım atlanır. Create düğmesini tıklayın.
API'yi yayımlayın.
API yapılandırmaları yalnızca API bir ortama yayımlandıktan sonra etkili olur. Bu örnekte arka uç hizmeti yalnızca Production ortamında yapılandırıldığından API'yi yalnızca Production ortamına yayımlayabilirsiniz. API'yi başka bir ortama yayımlamak için önce arka uç hizmetini o ortamda yapılandırmanız gerekir. API'nin başarıyla oluşturulduğunu belirten mesajda Publish düğmesini tıklayın ve ekrandaki talimatları izleyerek API'yi Production ortamına yayımlayın.
Adım 4: Uygulama oluşturma ve uygulamaya API çağrısı yapma izni verme
Uygulama, bir API'yi çağırmak için kullanılan bir kimliktir. API'yi oluştururken Güvenlik Kimlik Doğrulaması parametresi Alibaba Cloud App olarak ayarlandığından bir uygulama oluşturmanız ve bu uygulamayı API'yi çağırmak için yetkilendirmeniz gerekir.
Uygulama oluşturun.
API Gateway konsolunun sol gezinme bölmesinde Call APIs-Apps seçeneğini belirleyerek bir uygulama oluşturun. Alibaba Cloud App kimlik doğrulama yöntemi AppKey ve AppSecret çifti ile AppCode olmak üzere iki modu destekler. Bu örnekte AppCode kullanılır. Daha fazla bilgi için bkz. API yetkilendirme.
Uygulamaya API'yi çağırma izni verin.
APIs sayfasında oluşturulan API'yi bulun ve İşlemler sütununda Authorize düğmesini tıklayın. Aşama parametresini API'yi yayımladığınız ortama ayarlayın. Bu örnekte Aşama parametresi Production olarak ayarlanır. Yetkilendirme İçin Uygulama Seçin bölümünün arama kutusuna oluşturduğunuz uygulamanın adını girin. Arama sonucunda oluşturulan uygulamayı seçin, İşlemler sütununda Ekle düğmesini tıklayın ve ardından Onayla düğmesini tıklayın. Uygulamanın API'yi çağırma yetkisine sahip olduğunu bildiren bir mesaj görüntülenir.
Adım 5: API'yi hata ayıklama
API Gateway çevrimiçi hata ayıklama özelliği sağlar. API'yi istemcilerden çağırmadan önce doğru şekilde yapılandırıldığını doğrulamak için bu özelliği kullanın.
APIs sayfasında oluşturulan API'nin adını tıklayın. API ayrıntıları sayfasında sol gezinme ağacında Debug API düğmesini tıklayın. İstek parametreleri tanımladıysanız API'nin beklendiği gibi çalıştığını doğrulamak için farklı değerler girebilirsiniz.
Hata ayıklama sırasında Uygulama Adı parametresinin yetkilendirilmiş uygulamaya ayarlandığından ve hata ayıklama ortamının uygulamanın yetkilendirildiği ortamla eşleştiğinden emin olun. Aksi takdirde hata ayıklama başarısız olabilir. Bu örnekte Production seçilmiştir.
Hata ayıklama başarılı olduktan sonra döndürülen olay kimliğine dayanarak olay veri yolunuzdaki olay ayrıntılarını sorgulayabilirsiniz.
Adım 6: API'yi çağırma
Artık API'yi oluşturdunuz ve yayımladınız, uygulamayı oluşturdunuz ve yetkilendirdiniz, ayrıca API'yi hata ayıkladınız. AppCode kullanarak API'yi iş sisteminizden çağırabilirsiniz.
API'yi nasıl çağıracağınız hakkında daha fazla bilgi için bkz. Basit kimlik doğrulama (AppCode) kullanarak API çağırma.