Kom igång med Azure API Center-tillägget för Visual Studio Code

Om du vill skapa, identifiera, prova och använda API:er i ditt API Center kan du använda Azure API Center-tillägget i din Visual Studio Code-utvecklingsmiljö:

• Skapa API:er – Gör API:er som du skapar identifierbara för andra genom att registrera dem i api-centret. Api-designens överensstämmelse mellan skift och vänster checkar in i Visual Studio Code med integrerat stöd för lintning. Se till att nya API-versioner inte bryter API-konsumenter med icke-bakåtkompatibel ändringsidentifiering.

• Identifiera API:er – Bläddra bland API:erna i api-centret och visa deras information och dokumentation.

• Prova API:er – Använd Swagger-användargränssnittet eller REST-klienten för att utforska API-begäranden och svar.

• Använd API:er – Generera API SDK-klienter för ditt 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.

Förutsättningar

• Ett eller flera API-center i din Azure-prenumeration. Om du inte redan har skapat ett kan du läsa Snabbstart: Skapa ditt API-center.

  För närvarande måste du tilldelas rollen Deltagare eller högre behörigheter för att få åtkomst till API-center med tillägget.

• Visual Studio Code

• Azure API Center-tillägg för Visual Studio Code

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
• Spektraltillägg – för att köra api-designkonformningskontroller för skift till vänster i Visual Studio Code
• Optic CLI – för att identifiera icke-bakåtkompatibla ändringar mellan API-specifikationsdokument

Ställ in

1. Installera Azure API Center-tillägget för Visual Studio Code från Visual Studio Code Marketplace. Installera valfria tillägg efter behov.
2. I Visual Studio Code går du till aktivitetsfältet till vänster och väljer API Center.
3. 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 ett Azure-konto 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.

Registrera API:er

Registrera ett API i api-centret direkt från Visual Studio Code, antingen genom att registrera det som en engångsåtgärd eller med en CI/CD-pipeline.

1. Använd kortkommandot Ctrl+Skift+P för att öppna kommandopaletten. Skriv Azure API Center: Registrera API och tryck på Retur.
2. Välj hur du vill registrera ditt API med ditt API Center:
   • Steg för steg är bäst för engångsregistrering av API:er.
   • CI/CD lägger till en förkonfigurerad GitHub- eller Azure DevOps-pipeline till din aktiva Visual Studio Code-arbetsyta som körs som en del av ett CI/CD-arbetsflöde för varje incheckning till källkontrollen. Vi rekommenderar att du inventar API:er med ditt API Center med HJÄLP av CI/CD för att säkerställa att API-metadata inklusive specifikation och version förblir aktuella i API-centret när API:et fortsätter att utvecklas över tid.
3. Slutför registreringssteg:
   • För Steg-för-steg väljer du API-centret för att registrera API:er med och svarar på frågor med information som API-titel, typ, livscykelsteg, version och specifikation för att slutföra API-registreringen.
   • För CI/CD väljer du antingen GitHub eller Azure DevOps, beroende på vilken källkontrollmekanism du föredrar. En Visual Studio Code-arbetsyta måste vara öppen för Azure API Center-tillägget för att lägga till en pipeline på din arbetsyta. När filen har lagts till slutför du de steg som dokumenteras i själva CI/CD-pipelinefilen för att konfigurera miljövariabler och identiteter för Azure Pipeline/GitHub Action. Vid push-överföring till källkontroll registreras API:et i api-centret.

API-designefterlevnad

För att säkerställa designefterlevnad med organisationsstandarder när du skapar API:er ger Azure API Center-tillägget för Visual Studio Code integrerat stöd för API-specifikationslintning med Spectral.

1. Använd kortkommandot Ctrl+Skift+P för att öppna kommandopaletten. Skriv Azure API Center: Ange aktiv API Style Guide och tryck på Retur.
2. Välj någon av standardreglerna som tillhandahålls, eller om din organisation redan har en formatguide tillgänglig använder du Välj lokal fil eller fjärr-URL för indata för att ange den aktiva regeluppsättningen i Visual Studio Code. Tryck på Retur.

När en aktiv API-formatguide har angetts utlöser en lokal lintningsåtgärd i Visual Studio Code genom att öppna en OpenAPI- eller AsyncAPI-baserad specifikationsfil. Resultaten visas både infogade i redigeraren och i fönstret Problem (Visa>problem eller Ctrl+Skift+M).

Identifiering av icke-bakåtkompatibla ändringar

När du introducerar nya versioner av api:et är det viktigt att se till att de ändringar som introduceras inte bryter API-konsumenter i tidigare versioner av ditt API. Azure API Center-tillägget för Visual Studio Code gör det enkelt med identifiering av icke-bakåtkompatibla ändringar för OpenAPI-specifikationsdokument som drivs av Optic.

1. Använd kortkommandot Ctrl+Skift+P för att öppna kommandopaletten. Skriv Azure API Center: Identifiera icke-bakåtkompatibel ändring och tryck på Retur.
2. Välj det första API-specifikationsdokumentet som ska jämföras. Giltiga alternativ inkluderar API-specifikationer som finns i DITT API Center, en lokal fil eller den aktiva redigeraren i Visual Studio Code.
3. Välj det andra API-specifikationsdokumentet som ska jämföras. Giltiga alternativ inkluderar API-specifikationer som finns i DITT API Center, en lokal fil eller den aktiva redigeraren i Visual Studio Code.

Visual Studio Code öppnar en diff-vy mellan de två API-specifikationerna. Eventuella icke-bakåtkompatibla ändringar visas både i redigeringsprogrammet och i fönstret Problem (Visa>problem eller Ctrl+Skift+M).

Identifiera API:er

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

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

2. Högerklicka på definitionen och välj Öppna API-dokumentation. En ny flik visas med Swagger-användargränssnittet för API-definitionen.

   

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

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.

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

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

   

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

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.
4. Välj Generera API-klient.

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

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

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

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

1. Skriv kortkommandot Ctrl+Skift+P för att öppna kommandopaletten.
2. Välj Azure API Center: Exportera api-specifikationsdokument.
3. Gör val för att navigera till en API-definition. En ny flik visas som återger ett API-specifikationsdokument.

Relaterat innehåll

• Azure API Center – viktiga begrepp