Dela via


Självstudie: Falska API-svar

GÄLLER FÖR: Alla API Management-nivåer

Serverdels-API:er importeras till ett API Management-API (APIM) eller skapas och hanteras manuellt. Stegen i den här självstudien visar hur du:

  • Använda API Management för att skapa ett tomt HTTP-API
  • Hantera ett HTTP API manuellt
  • Ange en princip för ett API så att den returnerar ett simulerat svar

Med den här metoden kan utvecklare fortsätta med implementeringen och testningen av API Management-instansen även om serverdelen inte är tillgänglig för att skicka verkliga svar.

Möjligheten att modellera svar är användbar i många scenarier:

  • Om API-fasaden utformas först och implementeringen av serverdelen kommer senare. Eller om serverdelen utvecklas parallellt.
  • Om serverdelen tillfälligt inte fungerar eller inte går att skala.

I den här självstudien lär du dig att:

  • Skapa ett test-API
  • Lägg till en åtgärd till test-API:et
  • Aktivera simulerade svar
  • Testa det simulerade API:et

Simulerat API-svar

Förutsättningar

Skapa ett test-API

Stegen i det här avsnittet visar hur du skapar ett HTTP-API utan serverdel.

  1. Logga in på Azure-portalen och navigera sedan till din API Management-instans.

  2. Välj API:er>+ Lägg till API>HTTP-panel.

    Definiera ett HTTP-API

  3. I fönstret Skapa ett HTTP-API väljer du Fullständig.

  4. Ange Test-API som Visningsnamn.

  5. Välj Obegränsat för produkter.

  6. Kontrollera att Hanterad är valt för gatewayer.

  7. Välj Skapa.

    Skapa ett HTTP-API

Lägg till en åtgärd till test-API:et

Ett API exponerar en eller flera åtgärder. I det här avsnittet lägger du till en åtgärd i HTTP-API:et som du skapade. När du anropar åtgärden efter att du har slutfört stegen i det här avsnittet utlöses ett fel. När du har slutfört stegen i avsnittet Aktivera mocking av svar får du inga fel.

  1. Välj det API som du skapade i föregående steg.

  2. Välj + Lägg till åtgärd.

  3. I fönstret Klientdel anger du följande värden.

    Klientdelsfönster

    Inställning Värde beskrivning
    Visningsnamn Testanrop Namnet som visas i utvecklarportalen.
    URL (HTTP-verb) GET Välj ett av de fördefinierade HTTP-verben.
    URL /test En URL-sökväg för API:et.
    Beskrivning Valfri beskrivning av åtgärden som används för att tillhandahålla dokumentation i utvecklarportalen till utvecklare som använder det här API:et.
  4. Välj fliken Svar under fälten URL, Visningsnamn och Beskrivning. Ange inställningar på den här fliken för att definiera svarsstatuskoder, innehållstyper, exempel och scheman.

  5. Välj + Lägg till svar och välj 200 OK i listan.

    Lägg till svar på API-åtgärden

  6. Under rubriken Återangivelser till höger väljer du + Lägg till återgivning.

  7. Ange program/json i sökrutan och välj innehållstypen program/json .

  8. I textrutan Exempel anger du { "sampleField" : "test" }.

  9. Välj Spara.

    Lägga till representation i API-åtgärden

Även om det inte krävs för det här exemplet kan du konfigurera fler inställningar för en API-åtgärd på andra flikar, inklusive:

Tabb beskrivning
Fråga Lägg till frågeparametrar. Förutom att ange ett namn och en beskrivning kan du även ange värden som har tilldelats till en frågeparameter. Du kan markera ett av värdena som standard (valfritt).
Begär Definiera innehållstyper, exempel och scheman för begäranden.

Aktivera simulerade svar

  1. Välj det API som du skapade i Skapa ett test-API.

  2. Kontrollera att fliken Design är markerad i fönstret till höger.

  3. Välj den teståtgärd som du lade till.

  4. I fönstret Inkommande bearbetning väljer du + Lägg till princip.

    Lägg till bearbetningsprincip

  5. Välj Mock responses (Simulera svar ) i galleriet.

    Panelen Princip för simulerade svar

  6. I textrutan API Management-svar anger du 200 OK, application/json. Det här alternativet anger att ditt API ska returnera svars-exemplet som du definierade i föregående avsnitt.

    Ange mocking-svar

  7. Välj Spara.

    Dricks

    En gul stapel med texten Mocking är aktiverad . Detta indikerar att svaren som returneras från API Management hånas av mocking-principen och inte skapas av serverdelen.

Testa det simulerade API:et

  1. Välj det API som du skapade i Skapa ett test-API.

  2. Välj fliken Test.

  3. Kontrollera att API:et för testanrop har valts och välj sedan Skicka för att göra ett testanrop.

    Testa det simulerade API:et

  4. HTTP-svaret visar den JSON som användes som ett exempel i den första delen av självstudien.

    Exempel på HTTP-svar

Nästa steg

I den här självstudiekursen lärde du dig att:

  • Skapa ett test-API
  • Lägg till en åtgärd till test-API:et
  • Aktivera simulerade svar
  • Testa det simulerade API:et

Gå vidare till nästa kurs: