Självstudie: Fingera API-svar

Artikel
09/27/2021
4 minuter för att läsa

Backend-API:er kan importeras till API Management API (APIM) eller skapas och hanteras manuellt. Stegen i den här självstudien visar hur du använder APIM för att skapa ett tomt API och hantera det manuellt. Ange sedan en princip för ett API så att det returnerar ett fingerat svar. Den här metoden gör att utvecklare kan fortsätta med implementering och testning av APIM-instanser även om serverdelen inte är tillgänglig för att skicka verkliga svar.

Möjligheten att modellera svar kan vara användbar i ett antal 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 guiden får du lära dig att:

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

Svar från fingerat API

Förutsättningar

Lär dig Azure API Management-terminologin.
Förstå begreppet principer i Azure API Management.
Slutför följande snabbstart: Skapa en Azure API Management instans.

Skapa ett test-API

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

Logga in på Azure Portal och gå till din API Management instans.
Välj API:er > + Lägg till API Tom > API.
I fönstret Skapa ett tomt API väljer du Fullständig.
Ange Test-API som Visningsnamn.
Välj Obegränsat för Produkter.
Se till att Hanterad är valt i Gateways.
Välj Skapa.

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 det tomma API:et som du skapade. Ett fel genereras när du anropar åtgärden efter att du slutfört stegen i det här avsnittet. Du får inga fel när du har slutfört stegen senare i avsnittet Aktivera fingerade svar.

Portal
Azure CLI

Välj det API som du skapade i föregående steg.
Välj + Lägg till åtgärd.

Ange följande värden i fönstret Frontend.

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.

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.
Välj + Lägg till svar och välj 200 OK i listan.
Under rubriken Återangivelser till höger väljer du + Lägg till återgivning.
Ange application/json i sökrutan och välj innehållstypen application/json.
I textrutan Exempel anger du { "sampleField" : "test" }.
Välj Spara.

Lägg till API-åtgärd

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

Flik	Description
Query	Lägg till frågeparametrar. Förutom att ange ett namn och en beskrivning kan du ange värden som har tilldelats till en frågeparameter. Ett av värdena kan vara markerat som standard (valfritt).
Förfrågan	Definiera innehållstyper, exempel och scheman för förfrågningar.

Så här börjar du använda Azure CLI:

Använd bash-miljön i Azure Cloud Shell.
Om du vill kan du i stället installera Azure CLI för att köra CLI-referenskommandon.
- Om du använder en lokal installation loggar du in på Azure CLI med hjälp av kommandot az login. Slutför autentiseringsprocessen genom att följa stegen som visas i terminalen. Fler inloggningsalternativ finns i Logga in med Azure CLI.
- När du uppmanas till det installerar du Azure CLI-tillägg vid första användning. Mer information om tillägg finns i Använda tillägg med Azure CLI.
- Kör az version om du vill hitta versionen och de beroende bibliotek som är installerade. Om du vill uppgradera till den senaste versionen kör du az upgrade.

Om du vill lägga till en åtgärd i test-API:et kör du kommandot az apim api operation create:

az apim api operation create --resource-group apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world

Kör kommandot az apim api operation list för att se alla dina åtgärder för ett API:

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

Om du vill ta bort en åtgärd använder du kommandot az apim api operation delete. Hämta åtgärds-ID från föregående kommando.

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

Behåll den här åtgärden för användning i resten av den här artikeln.

Aktivera simulerade svar

Välj det API som du skapade i Skapa ett test-API.
Välj den teståtgärd som du lade till.
Kontrollera att fliken Design är markerad i fönstret till höger.
I fönstret Inkommande bearbetning väljer du + Lägg till princip.
Välj Fingera svar från galleriet.
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.
Välj Spara.

Tips

Ett gult fält med texten Mocking (Fingera) är aktiverat för ditt API anger att svar som returneras från API Management fingeras av fingerningsprincipen och inte produceras av backend-enheten.

Testa det simulerade API:et

Välj det API som du skapade i Skapa ett test-API.
Välj fliken Test.
Kontrollera att API:et Testanrop är markerat. Välj Skicka för att göra ett testanrop.
HTTP-svaret visar den JSON som användes som ett exempel i den första delen av självstudien.

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:

Omvandla och skydda ett publicerat API