Cloud-native API Gateway, konsol üzerinden veya bir OpenAPI dosyası içe aktararak örnek içinde veya dışında REST API'ler oluşturmanızı destekler. Bir API oluşturduktan sonra, istek yollarını ve yöntemlerini tanımlamak için işlemler ekleyebilirsiniz.
Kullanım senaryoları
Kullanım senaryonuzuna bağlı olarak API'leri örnek içinde veya dışında oluşturabilirsiniz.
Örnek içinde API oluşturun
Ayrılmış kaynak yönetimi: API yalnızca belirli bir örnek içindeki kaynakları veya dahili mantığı yönetir.
Güvenlik ve yalıtım: Veriler veya özellikler sıkı yalıtım gerektirir ve yalnızca örnek içinden çağrılabilir.
Basitleştirilmiş hizmet yapılandırması: Yapılandırmayı belirli bir örnekle sınırlamak API yönetimini kolaylaştırır.
Örnek dışında API oluşturun
Örnekler arası paylaşılan erişim: Birden çok örnek tek bir API tanımını paylaşır.
Merkezi yönetim ve izleme: Birleştirilmiş izin kontrolü, günlük kaydı ve trafik yönetimi.
Konsolda REST API oluşturun
Cloud-native API Gateway konsolda API oluşturmak için iki yol sunar: örnek içinde ve örnek dışında.
Örnek dışında
Cloud-native API Gateway konsolunda oturum açın.
Soldaki gezinme bölmesinde API seçeneğini tıklayın. Üst menü çubuğundan bir bölge seçin.
Create API seçeneğini tıklayın.
-
REST API kartında Create seçeneğini tıklayın. Create REST API panelinde parametreleri yapılandırın ve Onayla'yı tıklayın.
Parametre
Açıklama
API Name
API için bir ad girin. Ad global olarak benzersiz olmalıdır.
Base path
API için temel yol. Bir istemci belirli bir işlemi çağırdığında tam istek URL'si
http(s)://{domain name}/{base path}/{operation path}şeklindedir.Version Management
API sürüm yönetiminin etkinleştirilip etkinleştirilmeyeceğini belirtir. Bir API'nin farklı sürümleri bağımsızdır. Aynı API adını paylaşırlar ancak farklı temel bilgilere ve işlemlere sahip olabilirler. Belirli bir sürüme erişmek için isteğe sürüm tanımlayıcısını dahil edin.
Version Management özelliğini etkinleştirirseniz Usage ayarını da yapılandırmanız gerekir.
Not-
Usage değerini Query olarak ayarlarsanız Add Query parametresini yapılandırmanız gerekir.
-
Usage değerini Header olarak ayarlarsanız Add Header parametresini yapılandırmanız gerekir.
Version Management
Sürüm tanımlayıcısı Path, bir Query parametresi veya bir Header aracılığıyla iletilebilir.
-
Path: Tam istek yolu
/{base path}/{version_number}/{operation_path}şeklindedir. -
Query: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Query bölümünde belirttiğiniz sorgu parametresini içermeli ve değeri sürüm numarasına ayarlanmalıdır. -
Header: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Header bölümünde belirttiğiniz üst bilgiyi içermeli ve değeri sürüm numarasına ayarlanmalıdır.
Usage
API için bir açıklama girin.
Usage
Hedef kaynak grubunu seçin. Yeni bir tane oluşturmak için sağ taraftaki Create Resource Group seçeneğini tıklayın.
-
Query seçeneğini tıklayın.
-
Add Query kartında Usage seçeneğini tıklayın. Header panelinde parametreleri yapılandırın ve Onayla'yı tıklayın.
Parametre
Açıklama
Add Header
API için bir ad girin. Ad global olarak benzersiz olmalıdır.
Usage
API için temel yol. Bir istemci belirli bir işlemi çağırdığında tam istek URL'si
http(s)://{domain name}/{base path}/{operation path}şeklindedir.Path
API sürüm yönetiminin etkinleştirilip etkinleştirilmeyeceğini belirtir. Bir API'nin farklı sürümleri bağımsızdır. Aynı API adını paylaşırlar ancak farklı temel bilgilere ve işlemlere sahip olabilirler. Belirli bir sürüme erişmek için isteğe sürüm tanımlayıcısını dahil edin.
Version Management özelliğini etkinleştirirseniz Usage parametresini de yapılandırmanız gerekir.
Not-
Usage değerini Query olarak ayarlarsanız Add Query parametresini yapılandırmanız gerekir.
-
Usage değerini Header olarak ayarlarsanız Add Header parametresini yapılandırmanız gerekir.
Query
Sürüm tanımlayıcısı Path, bir Query parametresi veya bir Header aracılığıyla iletilebilir.
-
Path: Tam istek yolu
/{base path}/{version_number}/{operation_path}şeklindedir. -
Query: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Query bölümünde belirttiğiniz sorgu parametresini içermeli ve değeri sürüm numarasına ayarlanmalıdır. -
Header: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Header bölümünde belirttiğiniz üst bilgiyi içermeli ve değeri sürüm numarasına ayarlanmalıdır.
Header
API için bir açıklama girin.
Path
Hedef kaynak grubunu seçin. Yeni bir tane oluşturmak için sağ taraftaki Create Resource Group seçeneğini tıklayın.
-
Örnek içinde
Cloud-native API Gateway konsolunda oturum açın.
Soldaki gezinme bölmesinde Query seçeneğini tıklayın. Üst menü çubuğundan bir bölge seçin.
Add Query sayfasında hedef Header seçeneğini tıklayarak Add Header sayfasına gidin. Soldaki gezinme bölmesinde API seçeneğini tıklayın ve ardından Description seçeneğini tıklayın.
-
REST API kartında Resource Group seçeneğini tıklayın. Create Resource Group panelinde parametreleri yapılandırın ve Onayla'yı tıklayın.
Parametre
Açıklama
Create API
API için bir ad girin. Ad global olarak benzersiz olmalıdır.
REST API
-
API için bir veya daha fazla alan adı seçin.
-
Yeni bir alan adı oluşturmak için Add Domain Name seçeneğini tıklayın.
Create
API için temel yol. Bir istemci belirli bir işlemi çağırdığında tam istek URL'si
http(s)://{domain name}/{base path}/{operation path}şeklindedir.Create REST API
API sürüm yönetiminin etkinleştirilip etkinleştirilmeyeceğini belirtir. Bir API'nin farklı sürümleri bağımsızdır. Aynı API adını paylaşırlar ancak farklı temel bilgilere ve işlemlere sahip olabilirler. Belirli bir sürüme erişmek için isteğe sürüm tanımlayıcısını dahil edin.
Version Management özelliğini etkinleştirirseniz Usage ayarını da yapılandırmanız gerekir.
Not-
Usage değerini Query olarak ayarlarsanız Add Query parametresini yapılandırmanız gerekir.
-
Usage değerini Header olarak ayarlarsanız Add Header parametresini yapılandırmanız gerekir.
API Name
Sürüm tanımlayıcısı Path, bir Query parametresi veya bir Header aracılığıyla iletilebilir.
-
Path: Tam istek yolu
/{base path}/{version_number}/{operation_path}şeklindedir. -
Query: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Query bölümünde belirttiğiniz sorgu parametresini içermeli ve değeri sürüm numarasına ayarlanmalıdır. -
Header: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Header bölümünde belirttiğiniz üst bilgiyi içermeli ve değeri sürüm numarasına ayarlanmalıdır.
Base path
API için bir açıklama girin.
Version Management
Hedef kaynak grubunu seçin. Yeni bir tane oluşturmak için sağ taraftaki Create Resource Group seçeneğini tıklayın.
Version Management
Bu işlem için kullanım senaryosunu seçin.
-
Temel senaryo: Single Service.
-
Canary yayınlama senaryoları: By Percentage (Multi-service), By Content (Multi-service) ve By Tag (Proportion-based Routing).
NotTüm hedef hizmetler için trafik yüzdelerinin toplamı %100 olmalıdır.
Usage
Mevcut ağ geçidi veya VPC'den bir arka uç hizmeti ilişkilendirin. Hizmet yoksa Create Service seçeneğine tıklayarak bir hizmet oluşturun.
ÖnemliYeni bir hizmet oluşturduğunuzda port bilgileri hemen görünmeyebilir. Service Name açılan listesini genişletin ve Refresh seçeneğini tıklayın. Bilgiler eşzamansız olarak senkronize edilir ve görünmesi biraz zaman alabilir.
-
OpenAPI içe aktararak REST API oluşturun
API'leri örnek içinde veya dışında oluşturmak için bir OpenAPI dosyası içe aktarabilirsiniz.
Örnek dışında
Cloud-native API Gateway konsolunda oturum açın.
Soldaki gezinme bölmesinde API seçeneğini tıklayın. Üst menü çubuğundan bir bölge seçin.
Usage seçeneğini tıklayın.
-
REST API kartında Query seçeneğini tıklayın. Add Query panelinde parametreleri yapılandırın ve Usage seçeneğini tıklayın.
Parametre
Açıklama
Header
API için bir ad girin. Ad global olarak benzersiz olmalıdır.
Add Header
Local File veya Import OSS files kullanabilirsiniz.
NotHem yerel yükleme hem de OSS içe aktarma için kullanılan dosyalar OpenAPI spesifikasyonuna uygun olmalıdır.
Usage
Yerel bir dosya seçin veya metin içeriğini yapıştırın. Dosya boyutu 30 MB'ı aşamaz.
Path
OSS kaynaklarınızın bulunduğu bölgeyi seçin.
OSS bucket
Bir OSS paketi seçin. Bölge niteliği olmayan paketler desteklenmez.
Query
API sürüm yönetiminin etkinleştirilip etkinleştirilmeyeceğini belirtir. Bir API'nin farklı sürümleri bağımsızdır. Aynı API adını paylaşırlar ancak farklı temel bilgilere ve işlemlere sahip olabilirler. Belirli bir sürüme erişmek için isteğe sürüm tanımlayıcısını dahil edin.
Version Management özelliğini etkinleştirirseniz Usage ayarını da yapılandırmanız gerekir.
Not-
Usage değerini Query olarak ayarlarsanız Add Query parametresini yapılandırmanız gerekir.
-
Usage değerini Header olarak ayarlarsanız Add Header parametresini yapılandırmanız gerekir.
Header
Sürüm tanımlayıcısı Path, bir Query parametresi veya bir Header aracılığıyla iletilebilir.
-
Path: Tam istek yolu
/{base path}/{version_number}/{operation_path}şeklindedir. -
Query: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Query bölümünde belirttiğiniz sorgu parametresini içermeli ve değeri sürüm numarasına ayarlanmalıdır. -
Header: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Header bölümünde belirttiğiniz üst bilgiyi içermeli ve değeri sürüm numarasına ayarlanmalıdır.
Path
API için bir açıklama girin.
Query
Hedef kaynak grubunu seçin. Yeni bir tane oluşturmak için sağ taraftaki Create Resource Group seçeneğini tıklayın.
-
Örnek içinde
Cloud-native API Gateway konsolunda oturum açın.
Soldaki gezinme bölmesinde Add Query seçeneğini tıklayın. Üst menü çubuğundan bir bölge seçin.
Header sayfasında hedef Add Header seçeneğini tıklayarak Description sayfasına gidin. Soldaki gezinme bölmesinde API seçeneğini tıklayın ve ardından Resource Group seçeneğini tıklayın.
-
REST API kartında Create Resource Group seçeneğini tıklayın. Instances panelinde parametreleri yapılandırın ve Instances seçeneğini tıklayın.
Parametre
Açıklama
Instance ID
API için bir ad girin. Ad global olarak benzersiz olmalıdır.
Overview
-
API için bir veya daha fazla alan adı seçin.
-
Yeni bir alan adı oluşturmak için Add Domain Name seçeneğini tıklayın.
Create API
Local File veya Import OSS files kullanabilirsiniz.
NotHem yerel yükleme hem de OSS içe aktarma için kullanılan dosyalar OpenAPI spesifikasyonuna uygun olmalıdır.
Create
Yerel bir dosya seçin veya metin içeriğini yapıştırın. Dosya boyutu 30 MB'ı aşamaz.
Create REST API
OSS kaynaklarınızın bulunduğu bölgeyi seçin.
OSS bucket
Bir OSS paketi seçin. Bölge niteliği olmayan paketler desteklenmez.
API Name
API sürüm yönetiminin etkinleştirilip etkinleştirilmeyeceğini belirtir. Bir API'nin farklı sürümleri bağımsızdır. Aynı API adını paylaşırlar ancak farklı temel bilgilere ve işlemlere sahip olabilirler. Belirli bir sürüme erişmek için isteğe sürüm tanımlayıcısını dahil edin.
Version Management özelliğini etkinleştirirseniz Usage ayarını da yapılandırmanız gerekir.
Not-
Usage değerini Query olarak ayarlarsanız Add Query parametresini yapılandırmanız gerekir.
-
Usage değerini Header olarak ayarlarsanız Add Header parametresini yapılandırmanız gerekir.
Domain Name
Sürüm tanımlayıcısı Path, bir Query parametresi veya bir Header aracılığıyla iletilebilir.
-
Path: Tam istek yolu
/{base path}/{version_number}/{operation_path}şeklindedir. -
Query: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Query bölümünde belirttiğiniz sorgu parametresini içermeli ve değeri sürüm numarasına ayarlanmalıdır. -
Header: Tam istek yolu
/{base path}/{operation_path}şeklindedir. İstek, Add Header bölümünde belirttiğiniz üst bilgiyi içermeli ve değeri sürüm numarasına ayarlanmalıdır.
Add Domain Name
API için bir açıklama girin.
Base path
Hedef kaynak grubunu seçin. Yeni bir tane oluşturmak için sağ taraftaki Create Resource Group seçeneğini tıklayın.
Version Management
Bu işlem için kullanım senaryosunu seçin.
-
Temel senaryo: Single Service.
-
Canary yayınlama senaryoları: By Percentage (Multi-service), By Content (Multi-service) ve By Tag (Proportion-based Routing).
NotTüm hedef hizmetler için trafik yüzdelerinin toplamı %100 olmalıdır.
Version Management
Mevcut ağ geçidi veya VPC'den bir arka uç hizmeti ilişkilendirin. Hizmet yoksa Create Service seçeneğine tıklayarak bir hizmet oluşturun.
ÖnemliYeni bir hizmet oluşturduğunuzda port bilgileri hemen görünmeyebilir. Service Name açılan listesini genişletin ve Refresh seçeneğini tıklayın. Bilgiler eşzamansız olarak senkronize edilir ve görünmesi biraz zaman alabilir.
-
İşlem ekleyin
REST API ayrıntılar sayfasında Usage seçeneğini tıklayın.
-
Usage panelinde parametreleri yapılandırın ve Query seçeneğini tıklayın.
Parametre
Açıklama
Add Query
İşlem için bir ad girin. Ad API içinde benzersiz olmalıdır.
Usage
Bu işlem için istek yolu.
Header
Bu işlem için HTTP yöntemi. İşlem yolu ve yönteminin kombinasyonu API içinde benzersiz olmalıdır.
Add Header
İşlem için bir açıklama girin.
Usage
Header, Query ve path parametrelerinin yanı sıra bir Body tanımlayabilirsiniz.
Yol parametreleri aşağıdaki üç biçimden birinde işlem yolunda tanımlanabilir:
-
/books/{bookId}
-
/books/[bookId]
-
/books/:bookId
{bookId}biçimini kullanmanızı öneririz.NotBu tanımlamalar yalnızca SDK'lar ve belgeler oluşturmak içindir ve çalışma zamanında doğrulanmaz.
Path
Farklı durum kodları için yanıt veri yapısını tanımlar.
Bu tanımlamalar yalnızca belge oluşturma amacıyla kullanılır ve çalışma zamanında doğrulanmaz.
Query
Mock yapılandırmaları yalnızca API bir mock ortamına yayınlandığında etkili olur.
NotBu özellik yalnızca örnek dışında oluşturulan API'ler için kullanılabilir.
Header
Tüketici kimlik doğrulamasının etkinleştirilip etkinleştirilmeyeceğini belirtir. Varsayılan olarak devre dışıdır. Etkinleştirilirse erişilebilir olması için bu işleme bir tüketici yetkilendirmesi bağlamanız gerekir.
-