Sahne API yanıtlarıMock API responses

Arka uç API'leri bir APIM API’sine aktarılabilir veya el ile oluşturulup yönetilebilir.Backend APIs can be imported into an APIM API or created and managed manually. Bu öğreticideki adımlar, APIM kullanarak boş bir API oluşturma ve el ile yönetme işlemini gösterir.The steps in this tutorial show you how to use APIM to create a blank API and manage it manually. Bu öğreticide bir API üzerinde sahte yanıt döndürmesini sağlayacak bir ilke ayarlama işlemi gösterilmektedir.The tutorial shows how to set a policy on an API so it returns a mocked response. 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.This method enables developers to proceed with implementation and testing of the APIM instance even if the backend is not available to send real responses. Sahte yanıtlar oluşturabilmek birkaç senaryoda yararlı olabilir:Ability to mock up responses can be useful in a number of scenarios:

  • İlk olarak API cephesi tasarlanıp arka uç uygulaması daha sonra geldiğinde.When the API façade is designed first and the backend implementation comes later. Veya arka uç paralel olarak geliştirildiğinde.Or, the backend is being developed in parallel.
  • Arka uç geçici olarak çalışır durumda olmadığında veya ölçeklenemediğinde.When the backend is temporarily not operational or not able to scale.

Bu öğreticide şunların nasıl yapıldığını öğreneceksiniz:In this tutorial, you learn how to:

  • Test API’si oluşturmaCreate a test API
  • Test API’sine işlem eklemeAdd an operation to the test API
  • Sahte yanıt vermeyi etkinleştirmeEnable response mocking
  • Sahte API’yi test etmeTest the mocked API

Sahte işlem yanıtı

ÖnkoşullarPrerequisites

Test API’si oluşturmaCreate a test API

Bu bölümdeki adımlar arka uç olmadan boş bir API oluşturmayı gösterir.The steps in this section show how to create a blank API with no backend. Ayrıca, API’ye bir işlem eklemeyi gösterir.It also shows how to add an operation to the API. Bu bölümdeki adımları tamamladıktan sonra işlem çağrılırsa bir hata oluşur.Calling the operation after completing steps in this section produces an error. "Sahte yanıt vermeyi etkinleştirme" bölümündeki adımları tamamladıktan sonra herhangi bir hata almazsınız.You will get no errors after you complete steps in the "Enable response mocking" section.

Boş API oluşturma

  1. API Management hizmetinden API’ler’i seçin.Select APIs from the API Management service.
  2. Soldaki menüden + API Ekle'yi seçin.From the left menu, select + Add API.
  3. Listeden Boş API’yi seçin.Select Blank API from the list.
  4. Görünen ad için "Test API" yazın.Enter "Test API" for Display name.
  5. Ürünler için "Sınırsız" yazın.Enter "Unlimited" for Products.
  6. Oluştur’u seçin.Select Create.

Test API’sine işlem eklemeAdd an operation to the test API

API'ye işlem ekleme

  1. Önceki adımda oluşturduğunuz API’yi seçin.Select the API you created in the previous step.

  2. + İşlem Ekle’ye tıklayın.Click + Add Operation.

    AyarSetting DeğerValue AçıklamaDescription
    Görünen adDisplay name Test çağrısıTest call Geliştirici portalında görüntülenen ad.The name that is displayed in the Developer portal.
    URL (HTTP fiili)URL (HTTP verb) GETGET Önceden tanımlanmış HTTP fiillerinden birini seçebilirsiniz.You can choose from one of the predefined HTTP verbs.
    URLURL /test/test API için bir URL yolu.A URL path for the API.
    AçıklamaDescription Geliştirici portalında bu API’yi kullanan geliştiricilere belge sağlamak için kullanılan işlemin bir açıklamasını girin.Provide a description of the operation that is used to provide documentation to the developers using this API in the Developer portal.
    Sorgu sekmesiQuery tab Sorgu parametreleri ekleyebilirsiniz.You can add query parameters. Bir ad ve açıklama sağlamaya ek olarak bu parametreye atanabilecek değerleri belirtebilirsiniz.Besides providing a name and description, you can provide values that can be assigned to this parameter. Varsayılan olarak işaretlenebilecek değerlerde biri (isteğe bağlı).One of the values can be marked as default (optional).
    İstek sekmesiRequest tab İstek içerik türleri, örnekler ve şemalar tanımlayabilirsiniz.You can define request content types, examples, and schemas.
    Yanıt sekmesiResponse tab Bu tablodan sonraki adımlara bakın.See steps that follow this table. Yanıt durum kodları, içerik türleri, örnekler ve şemalar tanımlayın.Define response status codes, content types, examples, and schemas.
  3. URL, Görünen ad ve Açıklama alanlarının altında bulunan Yanıt sekmesini seçin.Select the Response tab, located under the URL, Display name, and Description fields.

  4. + Yanıt ekle’ye tıklayın.Click + Add response.

  5. Listeden 200 Tamam’ı seçin.Select 200 OK from the list.

  6. Sağ taraftaki Gösterimler başlığının altında + Gösterim ekle’yi seçin.Under the Representations heading on the right, select + Add representation.

  7. Arama kutusuna "application/json" yazın ve application/json içerik türünü seçin.Enter "application/json" into the search box and select the application/json content type.

  8. Örnek metin kutusuna { 'sampleField' : 'test' } girin.In the Sample text box, enter { 'sampleField' : 'test' }.

  9. Oluştur’u seçin.Select Create.

Sahte yanıt vermeyi etkinleştirmeEnable response mocking

Sahte yanıt vermeyi etkinleştirme

  1. "Test API’si oluşturma" adımında oluşturduğunuz API’yi seçin.Select the API you created in the "Create a test API" step.

  2. Eklediğiniz test işlemini seçin.Select the test operation that you added.

  3. Sağdaki pencerede Tasarım sekmesine tıklayın.In the window on the right, click the Design tab.

  4. Gelen işlem penceresinde +İlke ekle'ye tıklayın.In the Inbound processing window, click + Add policy.

  5. Galeriden Sahte yanıtlar kutucuğunu seçin.Select the Mock responses tile from the gallery.

    Sahte yanıtlar ilke kutucuğu

  6. API Management yanıtı metin kutusuna 200 OK, application/json yazın.In the API Management response textbox, type 200 OK, application/json. Bu seçim, API’nizin önceki bölümde tanımladığınız yanıt örneğini döndürmesi gerektiğini gösterir.This selection indicates that your API should return the response sample you defined in the previous section.

    Sahte yanıt vermeyi etkinleştirme

  7. Kaydet’e tıklayın.Click Save.

Sahte API’yi test etmeTest the mocked API

Sahte API'yi test etme

  1. "Test API’si oluşturma" adımında oluşturduğunuz API’yi seçin.Select the API you created in the "Create a test API" step.

  2. Test sekmesini açın.Open the Test tab.

  3. Test çağrısı API’sinin seçili olduğundan emin olun.Ensure the Test call API is selected.

    İpucu

    Sahte işlem etkin metnini içeren sarı çubuk, API Management’tan döndürülen yanıtların bir sahte işlem ilkesi gönderdiğini ve gerçek bir arka uç yanıtı göndermediğini gösterir.A yellow bar with the text Mocking is enabled indicates that responses returned from the API Management, sends a mocking policy and not an actual backend response.

  4. Bir test çağrısı yapmak için Gönder’i seçin.Select Send to make a test call.

  5. HTTP yanıtı, öğreticinin ilk bölümde örnek olarak sağlanan JSON’u görüntüler.The HTTP response displays the JSON provided as a sample in the first section of the tutorial.

    Sahte yanıt vermeyi etkinleştirme

VideoVideo

Sonraki adımlarNext steps

Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:In this tutorial, you learned how to:

  • Test API’si oluşturmaCreate a test API
  • Test API’sine işlem eklemeAdd an operation to the test API
  • Sahte yanıt vermeyi etkinleştirmeEnable response mocking
  • Sahte API’yi test etmeTest the mocked API

Sonraki öğreticiye ilerleyin:Advance to the next tutorial: