Eğitim: Örnek API yanıtları

UYGULANANLAR: Tüm API Management katmanları

Arka uç API'leri bir Azure API Management API'sine aktarılabilir veya el ile oluşturulup yönetilebilir. Bu öğreticideki adımlar şunların nasıl yapılacağını açıklar:

• Boş bir HTTP API'sini oluşturmak için API Management'ı kullanın.
• HTTP API'lerini el ile yönetin.
• Bir API'de, sahte bir yanıt döndürecek şekilde bir politika ayarlayın.

Bu yöntem, arka uç gerçek yanıtlar göndermek için kullanılamasa bile geliştiricilerin API Management örneğinin uygulanmasına ve test edilmesine devam etmesine olanak tanır.

İpucu

API ekipleri bu özelliği çalışma alanlarında kullanabilir. Çalışma alanları, API'lere ve kendi API çalışma zamanı ortamlarına yalıtılmış yönetim erişimi sağlar.

Sahte yanıtlar oluşturma özelliği birçok senaryoda kullanışlıdır:

• API ağ geçidi önce tasarlandığında ve arka uç uygulaması daha sonra gerçekleştiğinde veya arka uç paralel olarak geliştirildiğinde.
• Arka uç geçici olarak çalışmadığında veya ölçeklenemediğinde.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

• Test API’si oluşturma
• Test API’sine işlem ekleme
• Yanıt taklidini etkinleştir
• Sahte API’yi test etme

Önkoşullar

• API Management terminolojisini öğrenin.
• API Management'ta ilke kavramını anlama.
• Hızlı başlangıç Azure API Management örneği oluşturma adımını tamamlayın.

Test API’si oluşturma

Bu bölümdeki adımlarda arka ucu olmayan bir HTTP API'sinin nasıl oluşturulacağı gösterilmektedir.

1. Azure portalında oturum açın ve ardından API Management örneğine gidin.

2. Kenar çubuğu menüsünde API API'leri'ni> ve ardından + API Ekle'yi seçin. HTTP kutucuğunu seçin:

   

3. HTTP API'sini Oluştur penceresinde Tam'ı seçin.

4. Görünen ad alanına Test API'sini girin. Ad alanı otomatik olarak doldurulur.

5. Ürünler'de, bu değer varsa Sınırsız'ı seçin. Bu değer yalnızca bazı katmanlarda kullanılabilir. Bu öğretici için değeri boş bırakabilirsiniz, ancak yayımlamak için API'yi bir ürünle ilişkilendirmeniz gerekir. Daha fazla bilgi için bkz. İlk API'nizi içeri aktarma ve yayımlama.

6. Ağ Geçitleri'nde, bu seçenek mevcut olduğunda Yönetilen'i seçin. (Bu seçenek yalnızca belirli hizmet katmanlarında kullanılabilir.)

7. Oluştur'u belirleyin.

   

Test API’sine işlem ekleme

API bir veya daha fazla işlemi kullanıma sunar. Bu bölümde, oluşturduğunuz HTTP API'sine bir işlem eklersiniz. Bu bölümdeki adımlar tamamlandıktan sonra işlemin çağrılması bir hatayı tetikler. Yanıt taklidini etkinleştirme bölümündeki adımları tamamladıktan sonra hata almazsınız.

Portal

1. Önceki adımda oluşturduğunuz API'yi seçin.

2. + İşlem Ekle’yi seçin.

3. Ön uç penceresinde aşağıdaki değerleri girin:

   Ayar	Değer	Açıklama
   Görünen ad	Test çağrısı	Geliştirici portalında görüntülenen ad.
   İsim	test çağrısı	Bu alan otomatik olarak doldurulur.
   URL (ilk kutu)	GET	Önceden tanımlanmış HTTP fiillerinden birini seçin.
   URL (ikinci kutu)	/test	API için bir URL yolu.
   Açıklama		İşlemin isteğe bağlı açıklaması. API'yi kullanan geliştiricilere geliştirici portalında belgeler sağlar.

   

4. URL, Görünen ad ve Açıklama kutularının altında bulunan Yanıtlar sekmesini seçin. Yanıt durum kodlarını, içerik türlerini, örnekleri ve şemaları tanımlamak için bu sekmeye değerleri girin.

5. + Yanıt ekle'yi ve ardından listeden 200 Tamam'ı seçin.

   

6. Gösterimler bölümünde + Gösterim ekle'yi seçin.

7. Arama kutusuna application/json yazın ve ardından application/json içerik türünü seçin.

8. Örnek kutusuna yazın{ "sampleField" : "test" }.

9. Kaydet'i seçin.

   

Bu örnek için gerekli olmasa da, aşağıdaki tabloda açıklandığı gibi diğer sekmelerde bir API işlemi için daha fazla ayar yapılandırabilirsiniz:

Sekme	Açıklama
Sorgu	Sorgu parametreleri ekleyin. Ad ve açıklama sağlamanın yanı sıra, sorgu parametresine atanan değerleri de sağlayabilirsiniz. Değerlerden birini varsayılan (isteğe bağlı) olarak işaretleyebilirsiniz.
İstek	İstek içerik türlerini, örneklerini ve şemalarını tanımlayın.

Azure CLI

Azure CLI'yi kullanmaya başlamak için:

• Azure Cloud Shell'de Bash ortamını kullanın. Daha fazla bilgi için bkz . Azure Cloud Shell'i kullanmaya başlama.

  

• CLI başvuru komutlarını yerel olarak çalıştırmayı tercih ediyorsanız Azure CLI'yı yükleyin . Windows veya macOS üzerinde çalışıyorsanız Azure CLI’yi bir Docker kapsayıcısında çalıştırmayı değerlendirin. Daha fazla bilgi için bkz . Docker kapsayıcısında Azure CLI'yi çalıştırma.

  • Yerel yükleme kullanıyorsanız az login komutunu kullanarak Azure CLI ile oturum açın. Kimlik doğrulama işlemini tamamlamak için terminalinizde görüntülenen adımları izleyin. Diğer oturum açma seçenekleri için bkz. Azure CLI kullanarak Azure'da kimlik doğrulaması.

  • İstendiğinde, ilk kullanımda Azure CLI uzantısını yükleyin. Uzantılar hakkında daha fazla bilgi için bkz . Azure CLI ile uzantıları kullanma ve yönetme.

  • Yüklü sürümü ve bağımlı kitaplıkları bulmak için az version komutunu çalıştırın. En son sürüme yükseltmek için az upgrade komutunu çalıştırın.

Test API'nize işlem eklemek için az apim api operation create komutunu çalıştırın:

az apim api operation create --resource-group <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

Bir API için tüm işlemlerinizi görmek için az apim api operation list komutunu çalıştırın:

az apim api operation list --resource-group <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Bu işlemi bu makalenin geri kalanında kullanmak üzere saklayın. Bir işlemi kaldırmak istiyorsanız az apim api operation delete komutunu kullanabilirsiniz. Önceki komuttan işlem kimliğini alın.

az apim api operation delete --resource-group <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

Yanıt taklidini etkinleştir

1. Test API'sini oluşturma bölümünde oluşturduğunuz API'yi seçin.

2. Tasarım sekmesinin seçili olduğundan emin olun.

3. Eklediğiniz Test çağrısı işlemini seçin.

4. Gelen işleme bölümünde + Politika ekle'yi seçin.

   

5. Galeriden Sahte yanıtlar kutucuğunu seçin:

   

6. API Management yanıt kutusunda 200 Tamam, uygulama/json görüntülendiğinden emin olun. Bu seçim, API'nizin önceki bölümde tanımladığınız yanıt örneğini döndürmesi gerektiğini gösterir.

   

7. Kaydet'i seçin.

   İpucu

   Ekranda "Alay etme etkin" metnini gösteren sarı bir çubuk belirir. Bu ileti, API Management'tan döndürülen yanıtların taklit ilke tarafından verildiğini ve arka uç tarafından üretilmediğini gösterir.

Sahte API’yi test etme

1. Test API'sini oluşturma bölümünde oluşturduğunuz API'yi seçin.

2. Test sekmesinde Test çağrısı API'sinin seçili olduğundan emin olun ve ardından gönder'i seçerek test araması yapın:

   

3. HTTP yanıtı, öğreticinin ilk bölümünde örnek olarak sağlanan JSON'yi görüntüler:

   

Sonraki adım

Yayımlanan API’yi dönüştürme ve koruma