Självstudie: Simulerade API-svar

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

Serverdels-API:er importeras till ett Azure API Management API eller skapas och hanteras manuellt. Stegen i den här handledningen beskriver hur du:

• Använd 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 falskt 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.

Tips

API-team kan använda den här funktionen på arbetsytor. Arbetsytor ger isolerad administrativ åtkomst till API:er och egna API-körningsmiljöer.

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

• När API-fasaden utformas först och serverdelsimplementeringen sker senare, eller när serverdelen utvecklas parallellt.
• När serverdelen tillfälligt inte fungerar eller inte kan skalas.

I den här handledningen 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 API Management-terminologi.
• Förstå begreppet principer i API Management.
• Slutför snabbstarten 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 Portal 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. I Visningsnamn anger du Test-API.

5. I Produkter väljer du Obegränsat om det värdet är tillgängligt. Det här värdet är endast tillgängligt på vissa nivåer. Du kan lämna värdet tomt för den här självstudien, men du måste associera API:et med en produkt för att publicera det. Mer information finns i Importera och publicera ditt första API.

6. I Gateways väljer du Hanterad om det här alternativet är tillgängligt. (Det här alternativet kan endast nås på vissa tjänstnivåer.)

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 mockning av svar får du inget felmeddelande.

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 (första rutan)	GET	Välj ett av de fördefinierade HTTP-verben.
   URL (andra rutan)	/test	En URL-sökväg för API:et.
   Beskrivning		En valfri beskrivning av åtgärden. Den innehåller dokumentation i utvecklarportalen till de utvecklare som använder API:et.

   

4. Välj fliken Svar , som finns under rutorna URL, Visningsnamn och Beskrivning . Du anger värden 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 sedan 200 OK i listan.

   

6. I avsnittet Representationer väljer du + Lägg till representation.

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

8. I rutan 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, enligt beskrivningen i följande tabell:

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 Kom igång med 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 Autentisera till Azure 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 och hantera 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 <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

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 <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Behåll den här åtgärden för användning i resten av den här artikeln. Om du vill ta bort en åtgärd kan du använda 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 <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

Aktivera simulerade svar

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

2. Kontrollera att fliken Design är markerad.

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

4. I avsnittet Inkommande bearbetning väljer du + Lägg till princip.

   

5. Välj panelen Mock responses (Simulera svar ) från galleriet:

   

6. Se till att 200 OK, program/json visas i API Management-svarsrutan . Det här valet anger att ditt API ska returnera svarsexemplet som du definierade i föregående avsnitt.

   

7. Välj Spara.

   Tips

   Ett gult fält som visar texten Mocking är aktiverad visas. Det här meddelandet anger 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. På fliken Test kontrollerar du att API:et för testanrop är markerat och väljer sedan Skicka för att göra ett testanrop:

   

3. HTTP-svaret visar JSON som tillhandahålls som ett exempel i det första avsnittet i självstudien:

   

Nästa steg

Gå till nästa handledning:

Omvandla och skydda ett publicerat API