Öğretici: Sahte API yanıtları

UYGULANANLAR: Tüm API Management katmanları

Arka uç API'leri bir API Management (APIM) API'sine aktarılır veya el ile oluşturulur ve yönetilir. Bu öğreticideki adımlar şunların nasıl yapılacağını gösterir:

• Boş bir HTTP API'sini oluşturmak için API Management'ı kullanma
• HTTP API'lerini el ile yönetme
• Sahte yanıt döndürmek için BIR API'de ilke ayarlama

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 etmelerini sağlar.

Yanıtların sahtesini oluşturma özelliği birçok senaryoda yararlıdır:

• İlk olarak API cephesi tasarlanıp arka uç uygulaması daha sonra geldiğinde. Veya arka uç paralel olarak geliştirildiğinde.
• Arka uç geçici olarak çalışır durumda olmadığı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
• Sahte yanıt vermeyi etkinleştirme
• Sahte API’yi test etme

Önkoşullar

• Azure API Management terminolojisini öğrenin.
• Azure API Management'ta ilke kavramını anlayın.
• Şu hızlı başlangıcı tamamlayın: Azure API Management örneği oluşturma.

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. API'ler>+ API>HTTP ekle kutucuğunu seçin.

   

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

4. Görünen ad için Test API'sini girin.

5. Ürünler için Sınırsız'ı seçin.

6. Ağ Geçitleri için Yönetilen'in seçildiğinden emin olun.

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 ekleyeceksiniz. Bu bölümdeki adımlar tamamlandıktan sonra işlemin çağrılması bir hatayı tetikler. Yanıt sahtesini etkinleştirme bölümündeki adımları tamamladıktan sonra hiçbir hatayla karşı karşıya kalmazsı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	Value	Açıklama
   Görünen ad	Test çağrısı	Geliştirici portalında görüntülenen ad.
   URL (HTTP fiili)	GET	Önceden tanımlanmış HTTP fiillerinden birini seçin.
   URL	/test	API için bir URL yolu.
   Açıklama		bu API'yi kullanan geliştiricilere geliştirici portalında belge sağlamak için kullanılan işlemin isteğe bağlı açıklaması.

4. URL, Görünen ad ve Açıklama alanları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 ayarları girin.

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

   

6. Sağ taraftaki Gösterimler başlığının altında + Gösterim ekle’yi seçin.

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

8. Örnek metin kutusuna { "sampleField" : "test" } girin.

9. Kaydet'i seçin.

   

Bu örnek için gerekli olmasa da, aşağıdakiler de dahil olmak üzere 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.
İste	İ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'de Bash için hızlı başlangıç.

  

• 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 ile oturum açma.

  • İ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.

  • 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 apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world 

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 apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

Bir işlemi kaldırmak için az apim api operation delete komutunu kullanın. Önceki komuttan işlem kimliğini alın.

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

Bu işlemi bu makalenin geri kalanında kullanmak üzere tutun.

Sahte yanıt vermeyi etkinleştirme

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

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

3. Eklediğiniz test işlemini seçin.

4. Gelen işleme penceresinde + İlke ekle'yi seçin.

   

5. Galeriden Sahte yanıtlar'ı seçin.

   

6. API Management yanıtı metin kutusuna 200 OK, application/json yazın. 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

   Sahte oluşturma etkin metnini içeren sarı bir çubuk görüntülenir. Bu, API Management'tan döndürülen yanıtların sahte ilke tarafından sahte olduğunu ve arka uç tarafından üretmediğ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 sekmesini seçin.

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

   

4. HTTP yanıtı, öğreticinin ilk bölümde örnek olarak sağlanan JSON’u görüntüler.

   

Sonraki adımlar

Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:

• Test API’si oluşturma
• Test API’sine işlem ekleme
• Sahte yanıt vermeyi etkinleştirme
• Sahte API’yi test etme

Sonraki öğreticiye ilerleyin:

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