Dela via

Utforma och utveckla API:er med api Center-plugin-programmet för GitHub Copilot för Azure

API Center-plugin-programmet för GitHub Copilot för Azure påskyndar design och utveckling av nya API:er baserat på naturligt språk-promptar. Med AI-hjälp tillgänglig via API Center-plugin-programmet i kombination med API Center VS Code-tillägget, beskriver du bara ditt API och genererar snabbt en OpenAPI-specifikation för API-utveckling som uppfyller organisationens standarder. När du har genererat en kompatibel specifikation kan du registrera API:et med ditt API Center.

Förutsättningar

Tilläggskonfiguration

  1. Installera Azure API Center-tillägget för Visual Studio Code från Visual Studio Code Marketplace. Installera andra tillägg efter behov.

    Anteckning

    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.

Skicka en begäran till agenten @azure

Följ dessa steg för att generera en OpenAPI-specifikation med hjälp av frågor om naturligt språk med GitHub Copilot för Azure:

  1. Om du vill kan du ange en aktiv API-formatguide i Azure API Center-tillägget. 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 . Läs mer om API-specifikationslintning med hjälp av API Center-tillägget.

  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 an 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. Check that there are no duplicate keys.

    Copilot drivs av AI, så överraskningar och misstag är möjliga. Mer information finns i Vanliga frågor och svar om Copilot.

    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, fullständighet och efterlevnad med api-formatguiden.

    Förfina kommandotolken om det behövs för att återskapa specifikationen eller upprepa processen med hjälp av en annan formatguide som du anger i Azure API Center-tillägget.

    Tips/Råd

    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.

Registrera API:et i api-centret

Använd Azure API Center-tillägget för VS Code för att registrera API:et i api-centret från den genererade specifikationsfilen. När du har registrerat API:et kan du använda tillägget för att visa API-dokumentationen, generera en HTTP-klient, utföra ytterligare lintning och analys med mera.

  1. I VS Code väljer du knappen Registrera ditt API i API Center i chattpanelen eller väljer Azure API Center: Registrera API från kommandopaletten.

  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, versionsrubrik, versionslivscykel, definitionsrubrik, specifikationsnamn och definitionsfil (specifikation) för att slutföra API-registreringen.

När API:et har registrerats kan du utföra olika uppgifter med hjälp av tillägget. Visa till exempel API-dokumentationen i Swagger-användargränssnittet:

  1. Expandera API Center-trädvyn för att välja definitionen för den API-version som du registrerade.

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

Skärmbild av Swagger-användargränssnittet i VS Code-tillägget.

Relaterat innehåll