Självstudie: Importera och publicera ditt första API

Den här självstudien visar hur du importerar ett OpenAPI-specifikations-api i JSON-format till Azure API Management. Microsoft tillhandahåller server-API:et som används i det här exemplet och är värd för det på Azure på https://conferenceapi.azurewebsites.net?format=json .

När du importerar api:et för API Management till API Management API:et en fasad för backend-API:et. Du kan anpassa fasaden efter dina behov i API Management utan att röra backend-API:et. Mer information finns i Transformera och skydda ditt API.

I den här guiden får du lära dig att:

Efter importen kan du hantera API:et i Azure Portal.

Förutsättningar

• Förstå azure-API Management terminologin.
• Skapa en Azure API Management-instans.

Gå till API Management-instansen

1. I Azure Portal du efter och väljer API Management tjänster.

   

2. På sidan API Management tjänster väljer du din API Management instans.

   

Importera och publicera ett backend-API

Det här avsnittet visar hur du importerar och publicerar en OpenAPI-specifikation för backend-API:et.

1. I det vänstra navigeringsfönstret i din API Management instans väljer du API:er.

2. Välj OpenAPI-panelen.

3. I fönstret Skapa från OpenAPI-specifikation väljer du Fullständig.

4. Ange värdena från följande tabell. Välj sedan Skapa för att skapa ditt API.

   Du kan ange API-värden under skapandet eller senare genom att gå Inställningar fliken.

   

   Inställning	Värde	Beskrivning
   OpenAPI-specifikation	https: / /conferenceapi.azurewebsites.net?format=json	Tjänsten som implementerar API:et. API Management vidarebefordrar begäranden till den här adressen. Tjänsten måste finnas på en offentligt tillgänglig Internetadress.
   Visningsnamn	När du har fyllt i föregående tjänst-URL API Management det här fältet baserat på JSON.	Namnet som visas i utvecklarportalen.
   Namn	När du har fyllt i föregående tjänst-URL API Management det här fältet baserat på JSON.	Ett unikt namn för API:et.
   Beskrivning	När du har fyllt i föregående tjänst-URL API Management det här fältet baserat på JSON.	En valfri beskrivning av API:et.
   URL-schema	HTTPS	Vilka protokoll som har åtkomst till API:et.
   API URL-suffix	Konferens	Suffixet läggs till i bas-URL:en för API Management tjänsten. API Management särskiljer API:er med deras suffix, så suffixet måste vara unikt för varje API för en viss utgivare.
   Taggar		Taggar för att organisera API:er för sökning, gruppering eller filtrering.
   Produkter	Obegränsat	Association för en eller flera API:er. Varje API Management instans levereras med två exempelprodukter: Starter och Unlimited. Du publicerar ett API genom att associera API:et med en produkt, Obegränsat i det här exemplet. Du kan inkludera flera API:er i en produkt och erbjuda dem till utvecklare via utvecklarportalen. Om du vill lägga till det här API:et till en annan produkt skriver eller väljer du produktnamnet. Upprepa det här steget för att lägga till API:et i flera produkter. Du kan också lägga till API:er till produkter senare Inställningar sidan. Mer information om produkter finns i Skapa och publicera en produkt.
   Gateways	Hanterade	API-gatewayer som exponerar API:et. Det här fältet är endast tillgängligt i developer- Premium-nivåtjänster. Hanterad anger den gateway som är inbyggd API Management tjänsten och som hanteras av Microsoft i Azure. Gatewayer med egen värd är endast tillgängliga på tjänstnivån Premium utvecklare. Du kan distribuera dem lokalt eller i andra moln. Om inga gatewayer har valts är API:et inte tillgängligt och dina API-begäranden lyckas inte.
   Vilken är versionen för det här API:et?	Markera eller avmarkera	Mer information finns i Publicera flera versioner av ditt API.

   Anteckning

   Om du vill publicera API:et till API-konsumenter måste du associera det med en produkt.

5. Välj Skapa.

Om du har problem med att importera en API-definition kan du se listan över kända problem och begränsningar.

Testa det nya API:et i Azure Portal

Du kan anropa API-åtgärder direkt från Azure Portal, vilket ger ett bekvämt sätt att visa och testa åtgärderna.

1. I det vänstra navigeringsfönstret i din API Management instans väljer du API:er > Demo Conference API.

2. Välj fliken Test och välj sedan GetSpeakers. Sidan visar frågeparametrar och sidhuvuden, om det finns några. Ocp-Apim-Subscription-Key fylls i automatiskt för den prenumerationsnyckel som är associerad med detta API.

3. Välj Skicka.

   

   Backend svarar med 200 OK och vissa data.

Nästa steg

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

Gå vidare till nästa självstudie och lär dig hur du skapar och publicerar en produkt: