Öğretici: Sahte API yanıtları
Arka uç API'leri bir API Management (APIM) API'sine aktarılabilir veya el ile oluşturulabilir ve yönetilebilir. Bu öğreticide yer alan adımlar, APIM kullanarak boş bir API oluşturma ve el ile yönetme ve ardından sahte yanıt döndürecek şekilde API'de bir ilke ayarlamayı gösterir. Bu yöntem, arka ucun gerçek yanıtlar göndermek için kullanılamadığı durumlarda bile geliştiricilerin APIM örneğinde uygulama ve test işlemlerine devam etmesini sağlar.
Yanıtları taklit etme özelliği, birkaç senaryoda yararlı olabilir:
- İ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 şunların nasıl yapıldığı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ımlar arka uç olmadan boş bir API oluşturmayı gösterir.
Azure portal oturum API Management.
API'ler > + API Ekle Boş > API'yi seçin.
Boş API Oluştur penceresinde Tam'ı seçin.
Görünen ad için Test API'si girin.
Ürünler için Sınırsız'ı seçin.
Ağ Geçitleri'nin içinde Yönetilen'in seçildiğinden emin olun.
Oluştur’u seçin.
Test API’sine işlem ekleme
API bir veya daha fazla işlem gösterir. Bu bölümde, oluşturduğunuz boş API'ye bir işlem ekleyin. Bu bölümdeki adımları tamamladıktan sonra işlem çağrılırsa bir hata oluşur. Daha sonra Yanıt sahtesi etkinleştirme bölümünde adımları tamamlandıktan sonra hata almayacaksanız.
Önceki adımda oluşturduğunuz API’yi seçin.
+ İşlem Ekle’yi seçin.
Ön Uç penceresine 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. 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 isteğe bağlı işlem açıklaması. 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 girin 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 değildir, ancak bir API işlemi için aşağıdakiler dahil olmak üzere diğer sekmelerde ek ayarlar yalıtabilirsiniz:
| Tab | Description |
|---|---|
| Sorgu | Sorgu parametreleri ekleyin. Ad ve açıklama sağlamanın yanı sıra, sorgu parametresine atanan değerleri de sebilirsiniz. Varsayılan olarak işaretlenebilecek değerlerde biri (isteğe bağlı). |
| İstek | İstek içerik türlerini, örneklerini ve şemalarını tanımlayın. |
Sahte yanıt vermeyi etkinleştirme
Test API'si oluşturma altında oluşturduğunuz API'yi seçin.
Eklediğiniz test işlemini seçin.
Sağ pencerede Tasarım sekmesinin seçili olduğundan emin olun.
Gelen işlem 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.
Sahte API’yi test etme
Test API'si oluşturma altında oluşturduğunuz API'yi seçin.
Test sekmesini seçin.
Test çağrısı API’sinin seçili olduğundan emin olun. Bir test çağrısı yapmak için Gönder’i seçin.
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: