Öğ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.
İ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.
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.
Azure portalında oturum açın ve ardından API Management örneğine gidin.
API'ler>+ API>HTTP ekle kutucuğunu seçin.
HTTP API'sini oluştur penceresinde Tam'ı seçin.
Görünen ad için Test API'sini girin.
Ürünler için Sınırsız'ı seçin.
Ağ Geçitleri için Yönetilen'in seçildiğinden emin olun.
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.
Önceki adımda oluşturduğunuz API’yi seçin.
+ İşlem Ekle’yi seçin.
Ön uç penceresinde aşağıdaki değerleri girin.
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.
+ Yanıt ekle'yi seçin ve listeden 200 Tamam'ı seçin.
Sağ taraftaki Gösterimler başlığının altında + Gösterim ekle’yi seçin.
Arama kutusuna application/json yazın ve application/json içerik türünü seçin.
Örnek metin kutusuna
{ "sampleField" : "test" }
girin.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. |
Sahte yanıt vermeyi etkinleştirme
Test API'sini oluşturma bölümünde oluşturduğunuz API'yi seçin.
Sağdaki pencerede Tasarım sekmesinin seçili olduğundan emin olun.
Eklediğiniz test işlemini seçin.
Gelen işleme penceresinde + İlke ekle'yi seçin.
Galeriden Sahte yanıtlar'ı seçin.
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.
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
Test API'sini oluşturma bölümünde oluşturduğunuz API'yi seçin.
Test sekmesini seçin.
Test çağrısı API'sinin seçili olduğundan emin olun ve ardından gönder'i seçerek test araması yapın.
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: