Aracılığıyla paylaş

Öğretici: Sahte API yanıtları

  • Makale

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

Sahte API yanıtı

Önkoşullar

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.

    HTTP API'si tanımlama

  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.

    HTTP API'si oluşturma

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.

  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.

    Ön uç penceresi

    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.

    API işlemine yanıt ekleme

  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.

    API işlemine gösterim ekleme

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

  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.

    İşleme ilkesi ekleme

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

    Sahte yanıtlar ilke kutucuğu

  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.

    Sahte yanıt ayarlama

  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.

    Sahte API’yi test etme

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

    Sahte HTTP yanıtı

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