Aktivera och visa portalvyn i Azure API Center – VS Code-tillägget

Den här artikeln visar hur du ger företagsutvecklare åtkomst till Azure API Center-portalvyn i Visual Studio Code-tillägget för Azure API Center. Med hjälp av portalvyn kan utvecklare identifiera API:er i ditt Azure API Center, visa API-definitioner och eventuellt generera API-klienter när de inte har åtkomst till att hantera själva API-centret eller lägga till API:er i inventeringen. Åtkomst till API Center-portalvyn hanteras med hjälp av Microsoft Entra-ID och rollbaserad åtkomstkontroll i Azure.

Förutsättningar

För API Center-administratörer

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

• Behörigheter för att skapa en appregistrering i en Microsoft Entra-klientorganisation som är associerad med din Azure-prenumeration och behörigheter för att bevilja åtkomst till data i api-centret.

För apputvecklare

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

Följande Visual Studio Code-tillägg är valfria:

• Microsoft Kiota-tillägget – för att generera API-klienter
• GitHub Copilot och GitHub Copilot Chat, som har åtkomst till GitHub Copilot – för att använda språkmodellverktyg i agentläge för att identifiera API:er

Steg för API Center-administratörer för att aktivera åtkomst till API Center-portalvyn

Följande avsnitt innehåller steg för API Center-administratörer för att göra det möjligt för företagsutvecklare att komma åt API Center-portalvyn.

Skapa Microsoft Entra-appregistrering

Konfigurera först en appregistrering i din Microsoft Entra ID-klientorganisation. Appregistreringen gör det möjligt för API Center-portalen att komma åt data från ditt API Center för en inloggad användare.

API Center kan konfigurera appregistreringen automatiskt, eller så kan du skapa appregistreringen manuellt.

Konfigurera appregistreringen automatiskt

Följ dessa steg för att konfigurera appregistreringen automatiskt:

1. I Azure Portal går du till API-centret.
2. I den vänstra menyn väljer duINSTÄLLNINGAR för >.
3. På fliken Identitetsprovider väljer du Starta konfiguration.
4. På fliken Snabbkonfiguration väljer du Spara + publicera.

Om du behöver komma åt appregistreringen senare kan du hitta den i portalen under Appregistreringar. Programmet heter med följande format: <api-center-name-apic-aad>.

Konfigurera appregistreringen manuellt

Följ dessa steg om du vill skapa appregistreringen manuellt:

1. I Azure-portalen går du till Microsoft Entra ID>Hantera>appregistreringar.

2. Välj + Ny registrering.

3. På sidan Registrera ett program anger du följande värden:

   1. Ange Namn till ett beskrivande namn, till exempel api-center-portal
   2. Under Kontotyper som stöds väljer du Endast Konton i den här organisationskatalogen (<Katalognamn> – Enskild klient).
   3. I Omdirigerings-URI väljer du Enkelsidigt program (SPA) och anger URI:n. Ange URI:n för distributionen av API Center-portalen i följande formulär: https://<service-name>.portal.<location>.azure-apicenter.ms. Ersätt <service name> och <location> med namnet på ditt API-center och platsen där det distribueras, Exempel: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Välj Registrera.

Konfigurera ytterligare omdirigerings-URI:er för VS Code-tillägget

När du aktiverar API Center-portalvyn i Visual Studio Code-tillägget för API Center konfigurerar du även följande omdirigerings-URI:er i appregistreringen:

1. Gå till din appregistrering i Azure-portalen.

2. På sidan Hantera>autentisering väljer du Lägg till en plattform och väljer Mobil- och skrivbordsprogram.

3. Konfigurera följande tre anpassade omdirigerings-URI:er:
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Ersätt <application-client-id> med programmets (klient)-ID för den här appen. Du hittar det här värdet på sidan Översikt för appregistreringen.

Aktivera inloggning till API Center-portalvyn av Microsoft Entra-användare och -grupper

Företagsutvecklare måste logga in med ett Microsoft-konto för att se API Center-portalvyn för ditt API Center. Om det behövs kan du lägga till eller bjuda in utvecklare till din Microsoft Entra-klient.

Om du vill aktivera inloggning till API Center-portalen för åtkomst till API:er tilldelar du rollen Azure API Center Data Reader till användare eller grupper i din organisation, som är begränsad till DITT API Center.

Detaljerade krav och steg för att tilldela en roll till användare och grupper finns i Tilldela Azure-roller med hjälp av Azure-portalen. Korta steg följer:

1. I Azure Portal går du till API-centret.
2. I den vänstra menyn väljer du Åtkomstkontroll (IAM)>+ Lägg till rolltilldelning.
3. I fönstret Lägg till rolltilldelning anger du följande värden:
   1. På sidan Roll söker du efter och väljer Azure API Center Data Reader. Välj Nästa.
   2. På sidan Medlemmar går du till Tilldela åtkomst till och väljer Användare, grupp eller tjänstens huvudnamn>+ Välj medlemmar.
   3. På sidan Välj medlemmar söker du efter och väljer de användare eller grupper som rollen ska tilldelas till. Klicka på Välj och sedan på Nästa.
   4. Granska rolltilldelningen och välj Granska + tilldela.

När du har konfigurerat åtkomst till portalen kan konfigurerade användare logga in på portalen och visa API:erna i API-centret.

Steg för företagsutvecklare att komma åt API Center-portalvyn

Utvecklare kan följa dessa steg för att ansluta och logga in på en API Center-portalvy med hjälp av Visual Studio Code-tillägget. Inställningar för att ansluta till API Center måste anges av API Center-administratören. När du har anslutit kan utvecklare identifiera och använda API:erna i API-centret.

Ansluta till ett API Center

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

   

2. Använd kortkommandot Ctrl+Skift+P för att öppna kommandopaletten. Skriv Azure API Center: Anslut till ett API Center och tryck på Retur.

3. Svara på anvisningarna för att ange följande information:

   1. Körnings-URL:en för API-centret i formatet <service name>.data.<region>.azure-apicenter.ms (utan prefix https://). Exempel: contoso-apic.data.eastus.azure-apicenter.ms. Den här körnings-URL:en visas på sidan Översikt i API-centret i Azure-portalen.

   2. Programmets (klientens) ID från appregistreringen som konfigurerades av administratören i föregående avsnitt.

   3. Katalog-ID för hyresgästen från registreringen av appen som konfigurerades av administratören i det föregående avsnittet.

   Tips/Råd

   En API Center-administratör måste ange föregående anslutningsinformation för utvecklare eller tillhandahålla en direktlänk i följande format:
   vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

   När du har anslutit till API-centret visas namnet på API Center i API Center-portalvyn.

4. Om du vill visa API:erna i API-centret går du till API Center-namnet och väljer Logga in på Azure. Inloggning tillåts med ett Microsoft-konto som har tilldelats rollen Azure API Center Data Reader i API Center.

   

5. När du har loggat in väljer du API:er för att visa API:erna i API-centret. Expandera ett API för att utforska dess versioner och definitioner.

   

6. Upprepa föregående steg för att ansluta till fler API-center om åtkomsten har konfigurerats.

Identifiera och använda API:er i API Center-portalvyn

Portalvyn i API Center hjälper företagsutvecklare att identifiera API-information och starta API-klientutveckling. Utvecklare kan komma åt följande funktioner genom att högerklicka på en API-definition i API Center-portalvyn:

• Exportera API-specifikationsdokument – Exportera en API-specifikation från en definition och ladda sedan ned den som en fil
• Generera API-klient – Använd Microsoft Kiota-tillägget för att generera en API-klient för deras favoritspråk
• Generera Markdown – Generera API-dokumentation i Markdown-format
• OpenAPI-dokumentation – Visa dokumentationen för en API-definition och prova åtgärder i ett Swagger-användargränssnitt (endast tillgängligt för OpenAPI-definitioner)

Använda språkmodellverktyg

Utvecklare med åtkomst till API Center-portalvyn kan lägga till språkmodellverktyg för API Center som ska användas i GitHub Copilots agentläge. Läs mer om att använda verktyg i agentläge.

API Center-verktygen kan användas i agentläge för att söka efter API:er och API-versioner, API-definitioner och specifikationer, distributioner med mera med hjälp av frågor om naturligt språk.

Så här lägger du till och använder språklägesverktyg för API Center i GitHub Copilots agentläge:

1. Anslut till ett API-center enligt beskrivningen i ett tidigare avsnitt.

2. Öppna GitHub Copilot Chat i Visual Studio Code.

3. Ange läget för GitHub Copilot Chat till Agent.

4. Välj ikonen Verktyg i chattfönstret.

   

5. Välj ett eller flera API Center-verktyg som ska vara tillgängliga i chatten.

   

6. Ange en uppmaning i chattfönstret för att använda de tillgängliga verktygen. Till exempel:

   Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.
   

7. Granska svaren från GitHub Copilot Chat. Fortsätt med konversationen för att förfina resultatet eller ställa uppföljningsfrågor.

Felsökning

Det går inte att logga in på Azure

Om användare som har tilldelats rollen Azure API Center Data Reader inte kan slutföra inloggningsflödet när de har valt Logga in på Azure i API Center-portalvyn kan det uppstå problem med anslutningens konfiguration.

Kontrollera inställningarna i appregistreringen som du konfigurerade i Microsoft Entra-ID. Bekräfta värdena för applikationens (klientens) ID och katalogens (klientorganisationens) ID i appregistreringen och körnings-URL:en för API-centret. Konfigurera sedan anslutningen till API-centret igen.

Relaterat innehåll

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

• Metodtips för Azure RBAC

• Registrera en resursleverantör