Dela via

Skapa och registrera API:er med Azure API Center-tillägget för Visual Studio Code

  • Artikel

API-producentutvecklare i din organisation kan skapa och registrera API:er i API Center-inventeringen med hjälp av Azure API Center-tillägget för Visual Studio Code. API-utvecklare kan:

  • Lägg till ett befintligt API i ett API-center som en engångsåtgärd eller integrera en utvecklingspipeline för att registrera API:er som en del av ett CI/CD-arbetsflöde.
  • Använd GitHub Copilot för att generera nya OpenAPI-specifikationer från API-kod.
  • Använd frågor om naturligt språk med API Center-plugin-programmet för GitHub Copilot för Azure för att skapa nya OpenAPI-specifikationer.

API-konsumentutvecklare kan också dra nytta av funktioner i tillägget för att identifiera och använda API:er i API-centret och säkerställa API-styrning.

Förutsättningar

Följande Visual Studio Code-tillägg behövs för de angivna scenarierna:

Ställ in

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

  2. I Visual Studio Code går du till aktivitetsfältet till vänster och väljer API Center.

    Skärmbild av API Center-tillägget i aktivitetsfältet.

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

Registrera ett API – steg för steg

Följande steg registrerar ett API i api-centret som en engångsåtgärd.

  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 Manuell.
  3. Välj DET API-center som API:er ska registreras med.
  4. Besvara frågor med information som API-titel, typ, versionstitel, versionslivscykel, definitionsrubrik, specifikationsnamn och definitionsfil för att slutföra API-registreringen.

API:et läggs till i API Center-inventeringen.

Registrera API:er – CI/CD-pipeline

Följande steg registrerar ett API i api-centret med en CI/CD-pipeline. Med det här alternativet lägger du till en förkonfigurerad GitHub- eller Azure DevOps-pipeline i 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.

  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 CI/CD.
  3. Välj 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 nödvändiga miljövariabler och identiteter. Vid push-överföring till källkontroll registreras API:et i api-centret.

Läs mer om hur du konfigurerar ett GitHub Actions-arbetsflöde för att registrera API:er med ditt API Center.

Generera OpenAPI-specifikation från API-kod

Använd kraften i GitHub Copilot med Azure API Center-tillägget för Visual Studio Code för att skapa en OpenAPI-specifikationsfil från din API-kod. Högerklicka på API-koden, välj Copilot bland alternativen och välj Generera API-dokumentation. GitHub Copilot skapar en OpenAPI-specifikationsfil.

Kommentar

Den här funktionen är tillgänglig i förhandsversionen av API Center-tillägget.

Animering som visar hur du använder GitHub Copilot för att generera en OpenAPI-specifikation från kod.

När du har genererat OpenAPI-specifikationsfilen och kontrollerat att den är korrekt kan du registrera API:et med ditt API Center med hjälp av kommandot Azure API Center: Register API .

Generera OpenAPI-specifikation med hjälp av frågor om naturligt språk

API Center-plugin-programmet för GitHub Copilot för Azure (förhandsversion) hjälper dig att utforma nya API:er från och med frågor om naturligt språk. Med AI-hjälp kan du snabbt generera en OpenAPI-specifikation för API-utveckling som uppfyller organisationens standarder.

Kommentar

Den här funktionen är tillgänglig i förhandsversionen av API Center-tillägget.

  1. Om du vill kan du ange en aktiv API-formatguide. Använd kortkommandot Ctrl+Skift+P för att öppna kommandopaletten. Skriv Azure API Center: Ange API Style Guide, gör ett val och tryck på Retur.

    Om ingen formatguide har angetts används standardregeluppsättningen spectral:oas .

  2. I chattpanelen skickar du en begäran på naturligt språk till agenten @azure för att beskriva vad API:et gör. Exempel:

    @azure Generate OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards.

    Agenten svarar med ett OpenAPI-specifikationsdokument.

    Skärmbild som visar hur du använder @azure-tillägget för att generera en OpenAPI-specifikation från en prompt.

  3. Granska de genererade utdata för noggrannhet och efterlevnad med api-formatguiden. Förfina kommandotolken om det behövs för att återskapa.

    Dricks

    Effektiva uppmaningar fokuserar på ett API:s affärskrav i stället för implementeringsinformation. Kortare frågor fungerar ibland bättre än längre.

  4. När den uppfyller dina krav sparar du den genererade OpenAPI-specifikationen i en fil.

  5. Registrera API:et med ditt API Center. Välj knappen Registrera ditt API i API Center i chattpanelen eller välj Azure API Center: Registrera API från kommandopaletten och följ anvisningarna.

Relaterat innehåll