API-identifiering och förbrukning

Slutförd

API-identifiering och -förbrukning är en viktig del av användningen av API:er i hela organisationen.

I den här lektionen ser du hur API Center VS Code-tillägget gör att du enkelt kan identifiera och använda API:er.

Förutsättningar

Om du vill styra dina API:er via API Center-tillägget i VS Code måste du:

• Installera Visual Studio Code
• Installera API Center-tillägget

Följande Visual Studio Code-tillägg är valfria och behövs endast för vissa scenarier som anges:

• REST-klienttillägg – för att skicka HTTP-begäranden och visa svaren i Visual Studio Code direkt.
• Microsoft Kiota-tillägget – för att generera API-klienter.

API-identifiering och förbrukning

Du kan visa din organisations API-katalog direkt i Visual Studio Code, med alla dina API:er, versioner, definitioner, miljöer och distributioner. Med en blick får du omedelbart en översikt över alla API:er som är tillgängliga i din organisation.

Men vad händer om din organisation har hundratals eller tusentals API:er? Oroa dig inte, du kan söka efter API:er via sökikonen enligt nedan.

Visa API-dokumentation

Du kan också snabbt komma åt, förhandsgranska API-dokumentation och testa slutpunkter för dina API:er i VS Code.

1. Öppna API Center-tillägget från fliken .
2. Expandera API Center-trädvyn för att visa en API-definition.
3. Högerklicka på definitionen och välj Öppna API-dokumentation.
4. En ny flik visas med Swagger-användargränssnittet för API-definitionen.
5. Välj en slutpunkt och välj Prova, ange de obligatoriska parametrarna och välj Kör.

Prova API:er

Med API Center-tillägget kan du visa en .http-fil baserat på API-definitionen som anges i API Center. I den här filen kan du skicka http-begäranden direkt och visa svar direkt i redigeringsprogrammet.

Kommentar

Du måste installera REST-klienttillägget för att kunna använda den här funktionen.

1. Expandera API Center-trädvyn för att visa en API-definition.
2. Högerklicka på definitionen och välj Generera HTTP-fil.
3. En ny flik visas som återger ett .http-dokument som fylls i av API-specifikationen.
4. Om du vill göra en begäran väljer du en slutpunkt och väljer Skicka begäran.

Generera SDK:er

API Center-tillägget använder också Microsoft Kiota för att generera en klient för HTTP REST API för ditt favoritspråk enligt definitionen i OpenAPI-specifikationen. På så sätt kan du omedelbart generera klienter för alla eller valda slutpunkter för ditt API, som uppfyller dina affärsbehov.

Kommentar

Du måste installera Microsoft Kiota-tillägget för att kunna använda den här funktionen.

1. Expandera API Center-trädvyn för att visa en API-definition.

2. Högerklicka på definitionen och välj Generera API-klient. Fönstret Kiota OpenAPI Generator visas.

3. Välj de API-slutpunkter och HTTP-åtgärder som du vill inkludera i dina SDK:er. Du kan hovra på en slutpunkt och välja knappen +för att lägga till den eller -för att ta bort den.

4. När du är klar väljer du knappen Spela upp för att generera API-klienten.

5. Välj Generera API-klient.

   a. Ange konfigurationsinformation om SDK-namnet, namnområdet och utdatakatalogen.

   b. Välj språket för det genererade SDK:t.

API Center-portalen med egen värd

API Center-portalen är en webbplats där utvecklare och intressenter smidigt kan identifiera och interagera med API:er i din API-inventering. Med den här lokala webbplatsen tillhandahåller organisationer en webbaserad API-identifiering och förbrukningsupplevelse för konsumenter.

API Platform-tekniker vill ha en centraliserad och fristående plats för alla sina API-konsumenter, både interna och externa. För att komma igång kan du använda API Center-portalens startmall med hjälp av följande steg:

Kommentar

Anvisningarna nedan är för distribution till Azure Static Web Apps, men du kan distribuera på valfri infrastruktur.

1. Förgrena API Center-referensimplementeringskoden.

2. Skapa en static web app-resurs i Azure.

3. Under Distributionsinformation väljer du GitHub som källa och dirigerar till lagringsplatsen som innehåller API Center-startkoden.

4. Static Web Apps identifierar build-förinställningarna och fyller i med React.

5. Ange / som appplats.

6. Ange dist som utdataplats.

7. Välj Skapa.

   

Det kan ta upp till 5 minuter att se din kod publicerad på webbplatsen.

Om du vill visa API Center-portalen som körs i Static Web Apps väljer du Visa app i webbläsaren på fliken Översikt i den statiska webbappresurs som du skapade i Azure Portal.

Konfigurera rollbaserad åtkomstkontroll

Administratörer har fullständig kontroll över att tilldela behörigheter för åtkomst till API:er och tillgångar i organisationens API Center med rollbaserad åtkomstkontroll.

Kommentar

Som standard har administratörer för API Center inte åtkomst till API:er i API Center-portalen. Se till att tilldela rollen Azure API Center Data Reader till dig själv och andra administratörer.

För att få åtkomst till API:er i DITT API Center måste användarna logga in på portalen och ha nödvändiga behörigheter, begränsade till API Center. Om du vill aktivera inloggning tilldelar du rollen Azure API Center Data Reader till användare eller grupper i din organisation genom att följa stegen här.