Azure API Center-portalweergave inschakelen en weergeven - VS Code-extensie

In dit artikel wordt beschreven hoe u bedrijfsontwikkelaars toegang kunt bieden tot de azure API Center-portalweergave in de Visual Studio Code-extensie voor Azure API Center. Met behulp van de portalweergave kunnen ontwikkelaars API's detecteren in uw Azure API-centrum, API-definities weergeven en desgewenst API-clients genereren wanneer ze geen toegang hebben om het API-centrum zelf te beheren of API's aan de inventaris toe te voegen. Toegang tot de portalweergave van API Center wordt beheerd met behulp van Microsoft Entra ID en op rollen gebaseerd toegangsbeheer van Azure.

Vereiste voorwaarden

Voor beheerders van API-centrum

• Een API-centrum in uw Azure-abonnement. Als u er nog geen hebt gemaakt, raadpleeg dan Quickstart: Uw API-centrum maken.

• Machtigingen voor het maken van een app-registratie in een Microsoft Entra-tenant die is gekoppeld aan uw Azure-abonnement en machtigingen voor het verlenen van toegang tot gegevens in uw API-centrum.

Voor app-ontwikkelaars

• Azure API Center-extensie voor Visual Studio Code

De volgende Visual Studio Code-extensies zijn optioneel:

• Microsoft Kiota-extensie : API-clients genereren
• GitHub Copilot en GitHub Copilot Chat, voorzien van toegang tot GitHub Copilot : om taalmodelhulpprogramma's te gebruiken in de agentmodus voor het detecteren van API's

Stappen voor API Center-beheerders om toegang tot de portalweergave van API Center in te schakelen

De volgende secties bevatten stappen voor beheerders van het API-centrum om bedrijfsontwikkelaars toegang te geven tot de portalweergave van het API-centrum.

Microsoft Entra-app-registratie maken

Configureer eerst een app-registratie in uw Microsoft Entra ID-tenant. Met de app-registratie kan de API Center-portal toegang krijgen tot gegevens vanuit uw API-centrum namens een aangemelde gebruiker.

API Center kan de app-registratie automatisch instellen of u kunt de app-registratie handmatig maken.

De app-registratie automatisch instellen

Voer de volgende stappen uit om de app-registratie automatisch in te stellen:

1. Navigeer in Azure Portal naar uw API-centrum.
2. Selecteer in het menu aan de linkerkant de portalinstellingen> voor API Center.
3. Op het tabblad Id-provider selecteer Instellen starten.
4. Selecteer Opslaan en publiceren op het tabblad Snelle installatie.

Als u later toegang nodig hebt tot de app-registratie, kunt u deze vinden in de portal onder App-registraties. De toepassing heeft de volgende indeling: <api-center-name-apic-aad>.

De app-registratie handmatig instellen

Als u de app-registratie handmatig wilt maken, voert u de volgende stappen uit:

1. Navigeer in Azure Portal naar Microsoft Entra ID>App-registraties>.

2. Selecteer + Nieuwe registratie.

3. Op de pagina Een toepassing registreren stelt u de waarden als volgt in:

   1. Stel Naam in op een beschrijvende naam, zoals api-center-portal
   2. Selecteer onder Ondersteunde accounttypenalleen Accounts in deze organisatiemap (<directorynaam> - één tenant).
   3. Selecteer in Omleidings-URI de Toepassing met één pagina (SPA) en stel de URI in. Voer de URI van uw API Center-portalimplementatie in, in de volgende vorm: https://<service-name>.portal.<location>.azure-apicenter.ms. Vervang <service name> en <location> door de naam van uw API-centrum en de locatie waar deze is geïmplementeerd, bijvoorbeeld: https://myapicenter.portal.eastus.azure-apicenter.ms.
   4. Selecteer Registreren.

Aanvullende omleidings-URI's configureren voor VS Code-extensie

Wanneer u de api Center-portalweergave inschakelt in de Visual Studio Code-extensie voor API Center, configureert u ook de volgende omleidings-URI's in de app-registratie:

1. Navigeer in Azure Portal naar uw app-registratie.

2. Selecteer op de pagina Beheren>Verificatie, Een platform toevoegen en selecteer Mobiele en bureaubladtoepassingen.

3. Configureer de volgende drie aangepaste omleidings-URI's:
   https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>
   

   Vervang <application-client-id> door de toepassings-id (client) van deze app. U vindt deze waarde op de overzichtspagina van de app-registratie.

Inschakelen van aanmelden voor API Center portalweergave door Microsoft Entra-gebruikers en -groepen

Bedrijfsontwikkelaars moeten zich aanmelden met een Microsoft-account om de portalweergave van API Center voor uw API-centrum te zien. Voeg indien nodig ontwikkelaars toe aan of nodig ze uit voor uw Microsoft Entra-tenant.

Als u aanmelding bij de API Center-portal wilt inschakelen voor toegang tot API's, wijst u de rol Azure API Center-gegevenslezer toe aan gebruikers of groepen in uw organisatie, die zijn afgestemd op uw API-centrum.

Zie Azure-rollen toewijzen met behulp van Azure Portalvoor gedetailleerde vereisten en stappen voor het toewijzen van een rol aan gebruikers en groepen. Korte stappen volgen:

1. Navigeer in Azure Portal naar uw API-centrum.
2. Selecteer in het linkermenu Toegangsbeheer (IAM)>+ Roltoewijzing toevoegen.
3. Stel in het deelvenster Roltoewijzing toevoegen de waarden als volgt in:
   1. Zoek op de pagina Role naar en selecteer Azure API Center Data Reader. Kies Volgende.
   2. Selecteer op de pagina Leden, in Toegang toewijzen aan, de optie Gebruiker, groep of service-principal>+ Leden kiezen.
   3. Zoek en selecteer op de pagina Leden selecteren de gebruikers of groepen waaraan u de rol wilt toewijzen. Klik op Selecteren en vervolgens op Volgende.
   4. Controleer de roltoewijzing en selecteer Beoordelen en toewijzen.

Nadat u de toegang tot de portal hebt geconfigureerd, kunnen geconfigureerde gebruikers zich aanmelden bij de portal en de API's weergeven in uw API-centrum.

Stappen voor bedrijfsontwikkelaars voor toegang tot de portalweergave van API Center

Ontwikkelaars kunnen deze stappen volgen om verbinding te maken en u aan te melden bij een API Center-portalweergave met behulp van de Visual Studio Code-extensie. Instellingen om verbinding te maken met het API-centrum moeten worden verstrekt door de beheerder van het API-centrum. Nadat er verbinding is gemaakt, kunnen ontwikkelaars de API's detecteren en gebruiken in het API-centrum.

Verbinding maken met een API-centrum

1. Selecteer API Center in Visual Studio Code in de activiteitenbalk aan de linkerkant.

   

2. Gebruik de sneltoets Ctrl+Shift+P om het opdrachtenpalet te openen. Typ Azure API Center: maak verbinding met een API Center en druk op Enter.

3. Beantwoord de aanwijzingen om de volgende informatie in te voeren:

   1. De runtime-URL van uw API-centrum, in de indeling <service name>.data.<region>.azure-apicenter.ms (geen voorvoegsel met https://). Voorbeeld: contoso-apic.data.eastus.azure-apicenter.ms. Deze runtime-URL wordt weergegeven op de overzichtspagina van het API-centrum in de azure-portalweergave.

   2. De toepassings-id (client) van de app-registratie die is geconfigureerd door de beheerder in de vorige sectie.

   3. De directory-ID (tenant) van de app-registratie die door de beheerder in de vorige sectie is geconfigureerd.

   Hint

   Een BEHEERDER van het API-centrum moet de voorgaande verbindingsgegevens voor ontwikkelaars opgeven of een directe koppeling in de volgende indeling opgeven:
   vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

   Nadat u verbinding hebt gemaakt met het API-centrum, wordt de naam van het API-centrum weergegeven in de portalweergave van API Center.

4. Als u de API's in het API-centrum wilt weergeven, selecteert u Aanmelden bij Azure onder de naam van het API-centrum. Aanmelden is toegestaan met een Microsoft-account waaraan de rol Azure API Center-gegevenslezer is toegewezen in het API-centrum.

   

5. Nadat u zich hebt aangemeld, selecteert u API's om de API's in het API-centrum weer te geven. Vouw een API uit om de versies en definities ervan te verkennen.

   

6. Herhaal de voorgaande stappen om verbinding te maken met meer API-centra als de toegang is geconfigureerd.

API's detecteren en gebruiken in de portalweergave van API Center

De portalweergave van API Center helpt ontwikkelaars bij het detecteren van API-details en het starten van API-clientontwikkeling. Ontwikkelaars hebben toegang tot de volgende functies door met de rechtermuisknop op een API-definitie te klikken in de portalweergave van API Center:

• Api-specificatiedocument exporteren - Een API-specificatie exporteren uit een definitie en deze vervolgens downloaden als een bestand
• API-client genereren - De Microsoft Kiota-extensie gebruiken om een API-client te genereren voor hun favoriete taal
• Markdown genereren - Genereer API-documentatie in Markdown-indeling
• OpenAPI-documentatie - Bekijk de documentatie voor een API-definitie en probeerbewerkingen in een Swagger-gebruikersinterface (alleen beschikbaar voor OpenAPI-definities)

Taalmodelprogramma's gebruiken

Ontwikkelaars met toegang tot de api Center-portalweergave kunnen hulpprogramma's voor api Center-taalmodellen toevoegen voor gebruik in de agentmodus van GitHub Copilot. Meer informatie over het gebruik van hulpprogramma's in de agentmodus.

De hulpprogramma's van API Center kunnen worden gebruikt in de agentmodus om te zoeken naar API's en API-versies, API-definities en -specificaties, implementaties en meer met behulp van prompts voor natuurlijke taal.

Taalmodushulpprogramma's voor API Center toevoegen en gebruiken in de agentmodus van GitHub Copilot:

1. Maak verbinding met een API-centrum , zoals beschreven in een vorige sectie.

2. Open GitHub Copilot Chat in Visual Studio Code.

3. Stel de modus van GitHub Copilot Chat in op Agent.

4. Selecteer het pictogram Hulpmiddelen in het chatvenster.

   

5. Selecteer een of meer API Center-hulpprogramma's die beschikbaar zijn in de chat.

   

6. Voer een prompt in het chatvenster in om de beschikbare hulpprogramma's te gebruiken. Voorbeeld:

   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. Bekijk de antwoorden van GitHub Copilot Chat. Ga verder met het gesprek om de resultaten te verfijnen of vervolgvragen te stellen.

Problemen oplossen

Kan niet aanmelden bij Azure

Als gebruikers aan wie de rol Gegevenslezer van Azure API Center is toegewezen, de aanmeldingsstroom niet kunnen voltooien nadat ze Aanmelden bij Azure hebben geselecteerd in de portalweergave van API Center, kan er een probleem zijn met de configuratie van de verbinding.

Controleer de instellingen in de app-registratie die u hebt geconfigureerd in Microsoft Entra-id. Bevestig de waarden van de applicatie-id (client) en de directory-id (tenant) in de app-registratie en de runtime-URL van het API-centrum. Stel vervolgens de verbinding met het API-centrum opnieuw in.

Verwante inhoud

• API's bouwen en registreren met de Azure API Center-extensie voor Visual Studio Code

• Aanbevolen procedures voor Azure RBAC

• een resourceprovider registreren