API's detecteren en gebruiken met de Azure API Center-extensie voor Visual Studio Code
API-ontwikkelaars in uw organisatie kunnen API's in uw API-centrum detecteren en gebruiken met behulp van de Azure API Center-extensie voor Visual Studio Code. De extensie biedt de volgende functies:
ONTDEK API's : blader door de API's in uw API-centrum en bekijk de bijbehorende details en documentatie.
API's gebruiken: API SDK-clients genereren in hun favoriete taal, waaronder JavaScript, TypeScript, .NET, Python en Java, met behulp van de Microsoft Kiota-engine waarmee SDK's voor Microsoft Graph, GitHub en meer worden gegenereerd.
API-ontwikkelaars kunnen ook profiteren van functies in de extensie om API's te registreren in het API-centrum en ervoor te zorgen dat API-governance wordt gegarandeerd.
Tip
Als u wilt dat ontwikkelaars van bedrijfs-apps API's op een centrale locatie detecteren, kunt u eventueel een platform-API-catalogus inschakelen voor uw API-centrum in Visual Studio Code. De api-catalogus van het platform is een alleen-lezenweergave van de API-inventaris.
Vereisten
Een of meer API-centra in uw Azure-abonnement.
- Op dit moment moet u de rol Azure API Center-servicebijdrager of hogere machtigingen voor een API-centrum toewijzen om API's te beheren met de extensie.
- REST-clientextensie : http-aanvragen verzenden en de antwoorden rechtstreeks in Visual Studio Code weergeven
- Microsoft Kiota-extensie : API-clients genereren
Extensie instellen
Installeer de Azure API Center-extensie voor Visual Studio Code vanuit Visual Studio Code Marketplace. Installeer andere extensies die worden vermeld in de vereisten.
Notitie
Indien vermeld, zijn bepaalde functies alleen beschikbaar in de voorlopige versie van de Azure API Center-extensie. Wanneer u de extensie installeert vanuit Visual Studio Code Marketplace, kunt u ervoor kiezen om de releaseversie of een voorlopige versie te installeren. Schakel op elk gewenst moment tussen de twee versies met behulp van het contextmenu voor de knop Beheren van de extensie in de weergave Extensies.
Selecteer API Center in Visual Studio Code in de activiteitenbalk aan de linkerkant.
Als u niet bent aangemeld bij uw Azure-account, selecteert u Aanmelden bij Azure...en volgt u de aanwijzingen om u aan te melden. Selecteer een Azure-abonnement met het API-centrum (of API-centra) waaruit u API's wilt weergeven. U kunt ook filteren op specifieke abonnementen als u er veel van kunt bekijken.
API's detecteren
API Center-resources worden weergegeven in de structuurweergave aan de linkerkant. Vouw een API Center-resource uit om API's, versies, definities, omgevingen en implementaties te bekijken.
Zoek naar API's in een API Center met behulp van het zoekpictogram dat wordt weergegeven in het apis-structuurweergave-item .
API-documentatie weergeven
U kunt de documentatie voor een API-definitie in uw API-centrum bekijken en API-bewerkingen proberen. Deze functie is alleen beschikbaar voor op OpenAPI gebaseerde API's in uw API-centrum.
Vouw de structuurweergave van API Center uit om een API-definitie weer te geven.
Klik met de rechtermuisknop op de definitie en selecteer Open API-documentatie. Er wordt een nieuw tabblad weergegeven met de Swagger-gebruikersinterface voor de API-definitie.
Als u de API wilt proberen, selecteert u een eindpunt, selecteert u Uitproberen, voert u de vereiste parameters in en selecteert u Uitvoeren.
Notitie
Afhankelijk van de API moet u mogelijk autorisatiereferenties of een API-sleutel opgeven om de API uit te proberen.
Tip
Met behulp van de voorlopige versie van de extensie kunt u API-documentatie genereren in Markdown, een indeling die gemakkelijk te onderhouden en te delen is met eindgebruikers. Klik met de rechtermuisknop op de definitie en selecteer Markdown genereren.
HTTP-bestand genereren
U kunt een .http bestand weergeven op basis van de API-definitie in uw API-centrum. Als de REST-clientextensie is geïnstalleerd, kunt u de map aanvragen indienen vanuit de Visual Studio Code-editor. Deze functie is alleen beschikbaar voor op OpenAPI gebaseerde API's in uw API-centrum.
Vouw de structuurweergave van API Center uit om een API-definitie weer te geven.
Klik met de rechtermuisknop op de definitie en selecteer HTTP-bestand genereren. Er wordt een nieuw tabblad weergegeven dat een HTTP-document weergeeft dat is gevuld met de API-specificatie.
Als u een aanvraag wilt indienen, selecteert u een eindpunt en selecteert u Aanvraag verzenden.
Notitie
Afhankelijk van de API moet u mogelijk autorisatiereferenties of een API-sleutel opgeven om de aanvraag te doen.
API-client genereren
Gebruik de Microsoft Kiota-extensie om een API-client te genereren voor uw favoriete taal. Deze functie is alleen beschikbaar voor op OpenAPI gebaseerde API's in uw API-centrum.
- Vouw de structuurweergave van API Center uit om een API-definitie weer te geven.
- Klik met de rechtermuisknop op de definitie en selecteer API-client genereren. Het deelvenster Kiota OpenAPI Generator wordt weergegeven.
- Selecteer de API-eindpunten en HTTP-bewerkingen die u wilt opnemen in uw SDK's.
- Selecteer Api-client genereren.
Voer configuratiegegevens in over de SDK-naam, naamruimte en uitvoermap.
Selecteer de taal voor de gegenereerde SDK.
De client wordt gegenereerd.
Zie de Microsoft Kiota-extensie voor Visual Studio Code voor meer informatie over het gebruik van de Kiota-extensie.
API-specificatie exporteren
U kunt een API-specificatie exporteren uit een definitie en deze vervolgens downloaden als een bestand.
Een specificatie exporteren in de structuurweergave van de extensie:
Vouw de structuurweergave van API Center uit om een API-definitie weer te geven.
Klik met de rechtermuisknop op de definitie en selecteer Api-specificatiedocument exporteren. Er wordt een nieuw tabblad weergegeven waarmee een API-specificatiedocument wordt weergegeven.
U kunt ook een specificatie exporteren met behulp van het opdrachtpalet:
- Typ de sneltoets Ctrl+Shift+P om het opdrachtenpalet te openen.
- Selecteer Azure API Center: Api-specificatiedocument exporteren.
- Maak selecties om naar een API-definitie te navigeren. Er wordt een nieuw tabblad weergegeven waarmee een API-specificatiedocument wordt weergegeven.