Identifiera och använda API:er med Azure API Center-tillägget för Visual Studio Code
API-utvecklare i din organisation kan identifiera och använda API:er i ditt API Center med hjälp av Azure API Center-tillägget för Visual Studio Code. Tillägget innehåller följande funktioner:
Identifiera API:er – Bläddra bland API:erna i api-centret och visa deras information och dokumentation.
Använda API:er – Generera API SDK-klienter på deras favoritspråk, inklusive JavaScript, TypeScript, .NET, Python och Java, med hjälp av Microsoft Kiota-motorn som genererar SDK:er för Microsoft Graph, GitHub med mera.
API-utvecklare kan också dra nytta av funktioner i tillägget för att registrera API:er i API Center och säkerställa API-styrning.
Dricks
Om du vill att utvecklare av företagsappar ska kunna identifiera API:er på en central plats kan du också aktivera en plattforms-API-katalog för ditt API-center i Visual Studio Code. Plattformens API-katalog är en skrivskyddad vy över API-inventeringen.
Förutsättningar
Ett eller flera API-center i din Azure-prenumeration.
- För närvarande måste du tilldelas rollen Azure API Center-tjänstdeltagare eller högre behörigheter i ett API-center för att hantera API:er med tillägget.
- 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
Ställ in
Installera Azure API Center-tillägget för Visual Studio Code från Visual Studio Code Marketplace. Installera andra tillägg efter behov.
Kommentar
Där detta anges är vissa funktioner endast tillgängliga i Azure API Center-tilläggets förhandsversion. När du installerar tillägget från Visual Studio Code Marketplace kan du välja att installera versionsversionen eller en förhandsversion. Växla mellan de två versionerna när som helst med hjälp av tilläggets snabbmeny hantera knapp i vyn Tillägg.
I Visual Studio Code går du till aktivitetsfältet till vänster och väljer API Center.
Om du inte är inloggad på ditt Azure-konto väljer du Logga in på Azure... och följer anvisningarna för att logga in. Välj en Azure-prenumeration med DET API-center (eller API-center) som du vill visa API:er från. Du kan också filtrera efter specifika prenumerationer om du har många att visa från.
Identifiera API:er
API Center-resurser visas i trädvyn till vänster. Expandera en API Center-resurs för att se API:er, versioner, definitioner, miljöer och distributioner.
Sök efter API:er i ett API Center med hjälp av sökikonen som visas i apis-trädvyobjektet .
Visa API-dokumentation
Du kan visa dokumentationen för en API-definition i API-centret och prova API-åtgärder. Den här funktionen är endast tillgänglig för OpenAPI-baserade API:er i api-centret.
Expandera API Center-trädvyn för att visa en API-definition.
Högerklicka på definitionen och välj Öppna API-dokumentation. En ny flik visas med Swagger-användargränssnittet för API-definitionen.
Om du vill prova API:et väljer du en slutpunkt, väljer Prova, anger obligatoriska parametrar och väljer Kör.
Kommentar
Beroende på API:et kan du behöva ange autentiseringsuppgifter för auktorisering eller en API-nyckel för att prova API:et.
Dricks
Med förhandsversionen av tillägget kan du generera API-dokumentation i Markdown, ett format som är enkelt att underhålla och dela med slutanvändare. Högerklicka på definitionen och välj Generera Markdown.
Generera HTTP-fil
Du kan visa en .http fil baserat på API-definitionen i api-centret. Om REST-klienttillägget är installerat kan du göra begärandekatalogen från Visual Studio Code-redigeraren. Den här funktionen är endast tillgänglig för OpenAPI-baserade API:er i api-centret.
Expandera API Center-trädvyn för att visa en API-definition.
Högerklicka på definitionen och välj Generera HTTP-fil. En ny flik visas som återger ett .http-dokument som fylls i av API-specifikationen.
Om du vill göra en begäran väljer du en slutpunkt och väljer Skicka begäran.
Kommentar
Beroende på API:et kan du behöva ange autentiseringsuppgifter för auktorisering eller en API-nyckel för att göra begäran.
Generera API-klient
Använd Microsoft Kiota-tillägget för att generera en API-klient för ditt favoritspråk. Den här funktionen är endast tillgänglig för OpenAPI-baserade API:er i api-centret.
- Expandera API Center-trädvyn för att visa en API-definition.
- Högerklicka på definitionen och välj Generera API-klient. Fönstret Kiota OpenAPI Generator visas.
- Välj de API-slutpunkter och HTTP-åtgärder som du vill inkludera i dina SDK:er.
- Välj Generera API-klient.
Ange konfigurationsinformation om SDK-namnet, namnområdet och utdatakatalogen.
Välj språket för det genererade SDK:t.
Klienten genereras.
Mer information om hur du använder Kiota-tillägget finns i Microsoft Kiota-tillägget för Visual Studio Code.
Exportera API-specifikation
Du kan exportera en API-specifikation från en definition och sedan ladda ned den som en fil.
Så här exporterar du en specifikation i tilläggets trädvy:
Expandera API Center-trädvyn för att visa en API-definition.
Högerklicka på definitionen och välj Exportera API-specifikationsdokument. En ny flik visas som återger ett API-specifikationsdokument.
Du kan också exportera en specifikation med hjälp av kommandopaletten:
- Skriv kortkommandot Ctrl+Skift+P för att öppna kommandopaletten.
- Välj Azure API Center: Exportera api-specifikationsdokument.
- Gör val för att navigera till en API-definition. En ny flik visas som återger ett API-specifikationsdokument.