Cloud-native API Gateway konsolunda REST API'lerini yayınlayın, içe aktarın, dışa aktarın ve yayından kaldırın. Tek tıkla bir SDK ve ilgili dokümantasyon oluşturabilirsiniz.
Bir API Yayınlayın
Ön Koşullar
Bir API yayınlamadan önce işlemlerinin tanımlandığından ve oluşturulduğundan emin olun.
Prosedür
Cloud-native API Gateway iki tür API destekler: Paylaşılan API'ler ve Örnek Kapsamlı API'ler.
Paylaşılan API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde API seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Hedef API'nin adına tıklayın. Sağ üst köşede bulunan Publish düğmesine tıklayın.
-
Publish API panelinde parametreleri yapılandırın ve Publish düğmesine tıklayın.
Parametre
Açıklama
Domain Name
Bir alan adı seçin. API, yayınlamadan sonra bu alan adı üzerinden erişilebilir olacaktır.
Kullanılabilir bir alan adı yoksa Add Domain Name seçeneğine tıklayın. Daha fazla bilgi için bkz. Alan adı oluşturma.
Instance
Bir ağ geçidi örneği seçin. Ortamları yalıtmak için farklı örnekler kullanın.
Scenario
Senaryolar temel ve kademeli sürüm (canary release) içerir. Arka uç hizmet türleri hakkında bilgi edinmek için bkz. Yönlendirme.
Temel senaryolar
-
Mock: İşlemin mock yapılandırmasına dayalı olarak bir mock yanıt döndürür. Mock yapılandırması olmayan işlemlere erişilemez.
NotMock senaryosunda yayınlama yapmak için en az bir işlemin etkinleştirilmiş mock yapılandırmasına sahip olması gerekir. Aksi takdirde yayınlama başarısız olur.
-
Single Service: Tüm istekleri tek bir arka uç hizmetine yönlendirir. En yaygın kullanım durumudur.
Kademeli sürüm (Canary release) senaryoları
-
By Percentage (Multi-service): Trafiği arka uç hizmetlerine yüzdelik dağılıma göre yönlendirir. Trafik kaydırma ve kademeli sürümler için kullanılır.
NotTüm hizmetlerin ağırlıklarının toplamı 100 olmalıdır.
-
By Content (Multi-service): Trafiği eşleşme koşullarına göre farklı arka uç hizmetlerine yönlendirir. Default olarak işaretlenen kural, eşleşmeyen trafiği işler.
-
Desteklenen eşleşme türleri: Eşit, Önek ve Regex.
-
Desteklenen parametre konumları: Sorgu ve Başlık.
Birden çok koşul VE mantığıyla birleştirilir.
ÖnemliYalnızca bir kural Default olarak ayarlanabilir. Diğer tüm kurallar boş olmayan bir eşleşme koşuluna sahip olmalıdır.
-
-
By Tag (Proportion-based Routing): Trafiği birden çok arka uç hizmetinin sürümleri arasında yüzdelik olarak dağıtır. Uçtan uca kademeli sürümler için tek hizmetli yönlendirme önerilir.
Backend Services
Ağ geçidindeki veya VPC'deki bir arka uç hizmetiyle ilişkilendirin. Kullanılabilir hizmet yoksa Create Service seçeneğine tıklayarak Hizmet oluşturun.
Publish Description
Bu yayınlama için bir açıklama girin.
-
Örnek Kapsamlı API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde Instance seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Instance sayfasında hedef ağ geçidi örneğinin kimliğine tıklayın. Sol gezinme bölmesinde API seçeneğini belirleyin ve ardından hedef API'ye tıklayın.
-
Sağ üst köşede bulunan Publish düğmesine tıklayın. Publish API panelinde parametreleri yapılandırın ve Publish düğmesine tıklayın.
Parametre
Açıklama
Instance
API'nin yayınlandığı örnek. Ortamları yalıtmak için farklı örnekler kullanın.
VPC
Örneğin bulunduğu VPC.
Publish Scope
Yayınlanacak API işlemlerinin kapsamı. Ayrıntıları görüntülemek için bir işlem adına tıklayın.
Publish Description
Bu yayınlama için bir açıklama girin.
Bir API Sürümü Ekleyin
Şu anda yalnızca Paylaşılan API'lere sürüm ekleyebilirsiniz.
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde API seçeneğini belirleyin ve üst gezinme çubuğundan bir bölge seçin.
-
Hedef API'ye tıklayın. Sağ üst köşede bulunan seçeneklerini belirleyin ve aşağıdaki parametreleri yapılandırın:
Parametre
Açıklama
Usage
Desteklenen yöntemler: Path, Query ve Header.
Not-
Usage olarak Query seçerseniz Add Query parametresini yapılandırmanız gerekir.
-
Usage olarak Header seçerseniz Add Header parametresini yapılandırmanız gerekir.
-
Path yöntemi kullanılırken tam istek yolu şu şekilde olmalıdır:
/APIBasePath/VersionNumber/OperationPath. -
Query yöntemi kullanılırken
/APIBasePath/OperationPathyolunu kullanın ve sürüm numarasını Add Query ile belirtilen sorgu parametresine ekleyin. -
Header yöntemi kullanılırken
/APIBasePath/OperationPathyolunu kullanın ve sürüm numarasını Add Header ile belirtilen istek başlığına ekleyin.
-
(İsteğe bağlı) Sürümü ekledikten sonra sürümler arasında geçiş yapmak için sayfanın üst kısmındaki Version sekmesine tıklayın.
Yayınlama Geçmişini Görüntüleyin
Son 10 yayınlama kaydı saklanır.
-
Paylaşılan API'ler veya Örnek Kapsamlı API'ler için yayınlama geçmişini görüntüleyin.
Paylaşılan API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde API seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Hedef API'ye tıklayın ve ardından Publish History sekmesine tıklayın.
Örnek Kapsamlı API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde Instance seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Instance sayfasında hedef ağ geçidi örneğinin kimliğine tıklayın. Sol gezinme bölmesinde API seçeneğini belirleyin, hedef API'ye tıklayın ve ardından Publish History sekmesine tıklayın.
Geçmiş bir sürümün Actions sütununda View seçeneğine tıklayarak ayrıntılarını görüntüleyin.
Bir SDK ve Dokümantasyon Oluşturun
-
Paylaşılan API'ler veya Örnek Kapsamlı API'ler için bir SDK ve dokümantasyon oluşturun.
Paylaşılan API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde API seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Hedef API'ye tıklayın. Sağ üst köşede bulunan seçeneklerini belirleyin.
Örnek Kapsamlı API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde Instance seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Instance sayfasında hedef ağ geçidi örneğinin kimliğine tıklayın. Sol gezinme bölmesinde API seçeneğini belirleyin ve ardından hedef API'ye tıklayın.
Sağ üst köşede bulunan seçeneklerini belirleyin.
-
More > Generate SDK & Documentation iletişim kutusunda parametreleri yapılandırın ve Generate and Download düğmesine tıklayın.
Parametre
Açıklama
API Version
SDK ve dokümantasyon oluşturmak için API sürümünü seçin.
Not-
Örnek Kapsamlı API'ler sürümlemeyi desteklemediğinden bu seçenek kullanılamaz.
-
Paylaşılan API'ler için bu seçenek yalnızca API'yi oluştururken sürüm yönetimini etkinleştirdiyseniz kullanılabilir.
Language
Desteklenen SDK dilleri: Java, Golang, Python, Node.js, TypeScript ve Swift.
-
-
Sıkıştırılmış paket tarayıcınızın varsayılan klasörüne otomatik olarak indirilir.
NotPaketi açtıktan sonra SDK kullanım talimatları için
README.mddosyasına bakın.
Bir API İçe Aktarın
-
Paylaşılan API'ler veya Örnek Kapsamlı API'ler için bir API tanımı içe aktarın.
Paylaşılan API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde API seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Hedef API'ye tıklayın. Sağ üst köşede bulunan seçeneklerini belirleyin.
Örnek Kapsamlı API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde Instance seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Instance sayfasında hedef ağ geçidi örneğinin kimliğine tıklayın. Sol gezinme bölmesinde API seçeneğini belirleyin ve ardından hedef API'ye tıklayın.
Sağ üst köşede bulunan seçeneklerini belirleyin.
Create File based on OpenAPI panelinde parametreleri yapılandırın ve ardından Precheck and Create düğmesine tıklayın.
Bir API içe aktardığınızda API'nin adı OpenAPI tanım dosyasındaki info.title alanından alınır. Dosyada info.title belirtilmemişse sistem otomatik olarak bir ad oluşturur. Bir API oluşturulduktan sonra adını değiştiremezsiniz.
Mevcut bir API'nin adını değiştirmek için API tanım dosyasını dışa aktarın, dosyadaki info.title alanını değiştirin ve dosyayı tekrar içe aktarın.
Bir API Dışa Aktarın
-
Paylaşılan API'ler veya Örnek Kapsamlı API'ler için bir API tanımı dışa aktarın.
Paylaşılan API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde API seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Hedef API'ye tıklayın. Sağ üst köşede bulunan seçeneklerini belirleyin.
Örnek Kapsamlı API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde Instance seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Instance sayfasında hedef ağ geçidi örneğinin kimliğine tıklayın. Sol gezinme bölmesinde API seçeneğini belirleyin ve ardından hedef API'ye tıklayın.
Sağ üst köşede bulunan seçeneklerini belirleyin.
Export iletişim kutusunda OK düğmesine tıklayın. API tanımı tarayıcınızın varsayılan indirme klasörüne indirilir.
Bir API'yi Yayından Kaldırın
Bir API'yi yayından kaldırdığınızda işlemleri ilişkili alan adları üzerinden erişilemez hale gelir. İstekler artık işlenmez ancak yapılandırma ve yayınlama geçmişi korunur. Dikkatli ilerleyin.
-
Bir Paylaşılan API'yi veya Örnek Kapsamlı API'yi yayından kaldırın.
Paylaşılan API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde API seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Hedef API'ye tıklayın. Sağ üst köşede bulunan seçeneklerini belirleyin.
Örnek Kapsamlı API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde Instance seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Instance sayfasında hedef ağ geçidi örneğinin kimliğine tıklayın. Sol gezinme bölmesinde API seçeneğini belirleyin ve ardından hedef API'ye tıklayın.
Sağ üst köşede bulunan seçeneklerini belirleyin.
Confirm Unpublish iletişim kutusunda Shutdown düğmesine tıklayın.
Bir API Silin
Yayınlanmış bir API'yi silebilmeniz için öncelikle API'yi tüm örneklerden yayından kaldırmalısınız.
Bir API'yi silmek yapılandırmasını, dokümantasyonunu ve geçmişini kalıcı olarak kaldırır. Bu işlem geri alınamaz. Dikkatli ilerleyin.
-
Bir Paylaşılan API'yi veya Örnek Kapsamlı API'yi silin.
Paylaşılan API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde API seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Hedef API'ye tıklayın. Sağ üst köşede bulunan seçeneklerini belirleyin.
Örnek Kapsamlı API
Cloud-native API Gateway konsoluna giriş yapın. Sol gezinme bölmesinde Instance seçeneğini belirleyin. Üst gezinme çubuğundan bir bölge seçin.
Instance sayfasında hedef ağ geçidi örneğinin kimliğine tıklayın. Sol gezinme bölmesinde API seçeneğini belirleyin ve ardından hedef API'ye tıklayın.
Sağ üst köşede bulunan seçeneklerini belirleyin.
Confirm deletion iletişim kutusunda Delete düğmesine tıklayın.