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

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 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.

   

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.

   

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.

Portal

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.

   

   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.

   

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.

   

Ä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.

Azure CLI

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

• Använd Bash-miljön i Azure Cloud Shell. Mer information finns i Snabbstart för Bash i Azure Cloud Shell.

  

• Om du föredrar att köra CLI-referenskommandon lokalt installerar du Azure CLI. Om du kör i Windows eller macOS kan du köra Azure CLI i en Docker-container. Mer information finns i Så här kör du Azure CLI i en Docker-container.

  • 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. Andra inloggningsalternativ finns i Logga in med Azure CLI.

  • När du uppmanas att installera Azure CLI-tillägget vid första användningen. 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:t 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

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.

   

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

   

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.

   

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.

   

4. 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