API-detectie en -verbruik

  • 5 minuten

API-detectie en -verbruik zijn een belangrijk onderdeel van het gebruik van API's binnen een organisatie.

In deze les ziet u hoe u met de VS Code-extensie van API Center EENVOUDIG API's kunt detecteren en gebruiken.

Vereisten

Als u uw API's wilt beheren via de API Center-extensie in VS Code, moet u het volgende doen:

De volgende Visual Studio Code-extensies zijn optioneel en zijn alleen nodig voor bepaalde scenario's, zoals aangegeven:

API-detectie en -verbruik

U kunt de API-catalogus van uw organisatie rechtstreeks bekijken in Visual Studio Code, met al uw API's, versies, definities, omgevingen en implementaties. In één oogopslag krijgt u direct een overzicht van alle BESCHIKBARE API's binnen uw organisatie.

Maar wat gebeurt er als uw organisatie honderden of duizenden API's heeft? Maak u geen zorgen, u kunt zoeken naar API's via het zoekpictogram, zoals hieronder wordt weergegeven.

Schermopname van de zoek-API-optie in vs code

API-documentatie weergeven

U kunt ook snel toegang krijgen tot API-documentatie en eindpunten voor uw API's testen in VS Code. Schermopname van swagger-documentatie in vs code

  1. Open de API Center-extensie op het tabblad.
  2. Vouw de structuurweergave van API Center uit om een API-definitie weer te geven.
  3. Klik met de rechtermuisknop op de definitie en selecteer Open API-documentatie.
  4. Er wordt een nieuw tabblad weergegeven met de Swagger-gebruikersinterface voor de API-definitie.
  5. Selecteer een eindpunt en selecteer Uitproberen, geef de vereiste parameters op en selecteer Uitvoeren.

API's proberen

Met de API Center-extensie kunt u een HTTP-bestand weergeven op basis van de API-definitie die is opgegeven in het API Center. In dit bestand kunt u rechtstreeks HTTP-aanvragen verzenden en antwoorden daar in uw editor bekijken.

Notitie

U moet de REST-clientextensie installeren om deze mogelijkheid te kunnen gebruiken. Schermopname die laat zien hoe u rest-client gebruikt om .http van de API in VS Code weer te geven

  1. Vouw de structuurweergave van API Center uit om een API-definitie weer te geven.
  2. Klik met de rechtermuisknop op de definitie en selecteer HTTP-bestand genereren.
  3. Er wordt een nieuw tabblad weergegeven dat een HTTP-document weergeeft dat is gevuld met de API-specificatie.
  4. Als u een aanvraag wilt indienen, selecteert u een eindpunt en selecteert u Aanvraag verzenden.

SDK's genereren

De API Center-extensie maakt ook gebruik van Microsoft Kiota om een client te genereren voor uw HTTP REST API voor uw favoriete taal, zoals gedefinieerd in uw OpenAPI-specificatie. Hiermee kunt u direct clients genereren voor alle of geselecteerde eindpunten voor uw API, die voldoen aan de behoeften van uw bedrijf.

Notitie

U moet de Microsoft Kiota-extensie installeren om deze mogelijkheid te kunnen gebruiken.

  1. Vouw de structuurweergave van API Center uit om een API-definitie weer te geven.

  2. Klik met de rechtermuisknop op de definitie en selecteer API-client genereren. Het deelvenster Kiota OpenAPI Generator wordt weergegeven. Schermopname die laat zien hoe u een optie selecteert voor het genereren van een API-client in vs code met behulp van kiota

  3. Selecteer de API-eindpunten en HTTP-bewerkingen die u wilt opnemen in uw SDK's. U kunt de muisaanwijzer op een eindpunt bewegen en de knop +selecteren om het toe te voegen of '-' om het te verwijderen.

  4. Wanneer u klaar bent, selecteert u de knop Afspelen om de API-client te genereren. Schermopname die laat zien hoe u een optie selecteert voor het toevoegen of verwijderen van specifieke eindpunten in vs code met behulp van kiota

  5. Selecteer Api-client genereren.

    a. Voer configuratiegegevens in over de SDK-naam, naamruimte en uitvoermap.

    b. Selecteer de taal voor de gegenereerde SDK.

Portal voor zelf-hostend API Center

API Center Portal is een website voor ontwikkelaars en belanghebbenden om naadloos API's in uw API-inventaris te ontdekken en te gebruiken. Met deze zelf-hostende website bieden organisaties een webgebaseerde API-detectie- en verbruikservaring aan consumenten.

Schermopname van de landingspagina van de portal of website van contoso API Center

API Platform-technici willen een gecentraliseerde en zelfstandige locatie voor al hun API-consumenten, zowel intern als extern. Om aan de slag te gaan, kunt u de starterssjabloon voor de API Center-portal gebruiken met behulp van de volgende stappen:

Notitie

De onderstaande instructies zijn bedoeld voor de implementatie in Azure Static Web Apps, maar u kunt deze implementeren in uw infrastructuur naar keuze.

  1. Fork de api Center-referentie-implementatiecode .

  2. Maak een statische web-app-resource in Azure.

  3. Selecteer onder Implementatiedetails GitHub als bron en ga naar de opslagplaats met de starterscode van API Center.

  4. Static Web Apps detecteert de build-voorinstellingen en vult met React.

  5. Voer / de app-locatie in.

  6. Voer dist in als de uitvoerlocatie.

  7. Selecteer Maken.

    Schermopname van configureren voor Azure Static Web Apps

Het kan tot vijf minuten duren voordat uw code op de website is gepubliceerd.

Als u uw API Center-portal wilt weergeven die wordt uitgevoerd in Static Web Apps, selecteert u De app weergeven in de browser op het tabblad Overzicht in de Resource statische web-app die u hebt gemaakt in Azure Portal.

Schermopname van de geïmplementeerde webportal

Op rollen gebaseerd toegangsbeheer configureren

Beheerders hebben het volledige beheer over het toewijzen van machtigingen voor toegang tot API's en assets in het API Center van uw organisatie met op rollen gebaseerd toegangsbeheer.

Notitie

Beheerders van het API-centrum hebben standaard geen toegang tot API's in de API Center-portal. Zorg ervoor dat u de rol Azure API Center-gegevenslezer toewijst aan uzelf en andere beheerders.

Voor toegang tot API's in uw API Center moeten gebruikers zich aanmelden bij de portal en moeten ze over de benodigde machtigingen beschikken, met het bereik van uw API Center. Als u aanmelding wilt inschakelen, wijst u de rol van Azure API Center-gegevenslezer toe aan gebruikers of groepen in uw organisatie, met behulp van de stappen die hier worden beschreven.