Zelfstudie: API's registreren in uw API-inventaris

In deze zelfstudie wordt uitgelegd hoe u de API-inventaris in het API-centrum van uw organisatie start door API's te registreren en metagegevens toe te wijzen met behulp van Azure Portal.

Zie Belangrijke concepten voor meer informatie over API's, API-versies, definities en andere entiteiten die u kunt inventariseren in Azure API Center.

In deze zelfstudie leert u hoe u Azure Portal gebruikt voor het volgende:

Vereiste voorwaarden

• Een API-centrum in uw Azure-abonnement. Zie Quickstart: Uw API-centrum maken om een API-centrum te creëren.

• Een of meer API's die u wilt registreren in uw API-centrum. Hier volgen twee voorbeelden, met koppelingen naar hun OpenAPI-definities:

  • Swagger Petstore-API
  • Conferentie-API

• Definieer aangepaste metagegevens voor uw API's door de vorige zelfstudie te voltooien, Aangepaste metagegevens definiëren.

API's registreren

Wanneer u een API registreert (toevoegt) in uw API-centrum, bevat de API-registratie het volgende:

• Een titel (naam), type en beschrijving
• Versie-informatie
• Optionele koppelingen naar documentatie en contactpersonen
• Ingebouwde en aangepaste metagegevens die u hebt gedefinieerd

Nadat u een API hebt geregistreerd, kunt u versies en definities toevoegen aan de API.

De volgende stappen registreren twee voorbeeld-API's: Swagger Petstore-API en Conferentie-API (zie Vereisten). Als u wilt, registreert u ZELF API's.

1. Meld u aan bij Azure Portal en navigeer vervolgens naar uw API-centrum.

2. Selecteer IN het zijbalkmenu onder AssetsAPI's>+ Een API registreren.

3. Voeg op de pagina Een API registreren de volgende informatie toe voor de Swagger Petstore-API. U ziet nu de aangepaste line-of-business- en openbare metagegevens die u in de vorige zelfstudie onder aan de pagina hebt gedefinieerd.

   Configuratie	Waarde	Description
   API-titel	Voer de Swagger Petstore-API in.	Naam die u kiest voor de API
   identificatie	Nadat u de voorgaande titel hebt ingevoerd, genereert Azure API Center deze id, die u kunt overschrijven.	Azure-resourcenaam voor de API
   API-type	Selecteer REST in de vervolgkeuzelijst.	Soort API
   Samenvatting	Voer desgewenst een samenvatting in.	Samenvattingsbeschrijving van de API
   Beschrijving	Voer desgewenst een beschrijving in.	Beschrijving van de API
   Versie
   Versietitel	Voer een versietitel van uw keuze in, zoals v1.	Naam die u kiest voor de API-versie
   Versie-identificatie	Nadat u de voorgaande titel hebt ingevoerd, genereert Azure API Center deze id, die u kunt overschrijven.	Azure-resourcenaam voor de versie
   Levenscyclus van versie	Maak een selectie uit de vervolgkeuzelijst, bijvoorbeeld Testen of Productie.	Levenscyclusfase van de API-versie
   Externe documentatie	Voeg eventueel een of meer koppelingen naar externe documentatie toe.	Naam, beschrijving en URL van documentatie voor de API
   Licentie	Voeg eventueel licentiegegevens toe.	Naam, URL en id van een licentie voor de API
   Contactgegevens	Voeg eventueel informatie toe voor een of meer contactpersonen.	Naam, e-mail en URL van een contactpersoon voor de API
   Line-of-Business	Als u deze metagegevens in de vorige zelfstudie hebt toegevoegd, maakt u een selectie uit de vervolgkeuzelijst, zoals Marketing.	Aangepaste metagegevens die de bedrijfseenheid identificeren die eigenaar is van de API
   Openbaar	Als u deze metagegevens hebt toegevoegd, schakelt u het selectievakje in.	Aangepaste metagegevens waarmee wordt aangegeven of de API openbaar of alleen intern is

   

4. Selecteer Maken om de API te registreren.

5. Herhaal de voorgaande drie stappen om een andere API te registreren, zoals de Conference-API.

De API's worden weergegeven op de pagina API's in de portal. Als u een groot aantal API's toevoegt aan het API-centrum, gebruikt u het zoekvak en de filters op deze pagina om de gewenste API's te vinden.

Nadat u een API hebt geregistreerd, kunt u de eigenschappen van de API bekijken of bewerken. Selecteer op de pagina API's de API om pagina's weer te geven voor het beheren van de API-registratie.

Een API-versie toevoegen

Gedurende de levenscyclus kan een API meerdere versies hebben. U kunt een versie toevoegen aan een bestaande API in uw API-centrum, eventueel met een definitiebestand of bestanden.

Hier voegt u een versie toe aan een van uw API's:

1. Navigeer in Azure Portal naar uw API-centrum.

2. Selecteer API's in het zijbalkmenu en selecteer vervolgens een API, bijvoorbeeld Swagger Petstore.

3. Selecteer op de API-pagina onder Details versies

   

4. Voer op de pagina API-versie toevoegen de volgende informatie in of selecteer deze onder Versiegegevens:

   Configuratie	Waarde	Description
   Versietitel	Voer een versietitel van uw keuze in, zoals v2.	Naam die u kiest voor de API-versie
   Versie-identificatie	Nadat u de voorgaande titel hebt ingevoerd, genereert Azure API Center deze id, die u kunt overschrijven.	Azure-resourcenaam voor de versie
   Levenscyclus van versie	Maak een selectie in de vervolgkeuzelijst, zoals Productie.	Levenscyclusfase van de API-versie

5. Azure API Center ondersteunt definities in algemene indelingen voor tekstspecificaties, zoals OpenAPI 2 en 3 voor REST API's. Als u een API-definitie wilt toevoegen, voert u de volgende gegevens in of selecteert u deze onder Een specificatie selecteren:

   Configuratie	Waarde	Description
   Definitietitel	Voer een titel van uw keuze in, zoals v2-definitie.	Naam die u kiest voor de API-definitie
   Definitie-identificatie	Nadat u de voorgaande titel hebt ingevoerd, genereert Azure API Center deze id, die u kunt overschrijven.	Azure-resourcenaam voor de definitie
   Beschrijving	Voer desgewenst een beschrijving in.	Beschrijving van de API-definitie
   Specificatieformaat	Selecteer OpenAPI voor de Petstore-API.	Specificatie-indeling voor de API
   Specificatieversie	Voer een versie-id van uw keuze in, zoals 3.0.	Specificatieversie
   Bestand of URL	Blader naar een lokaal definitiebestand voor de Petstore-API of voer een URL in. Voorbeeld-URL: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	API-definitiebestand

   

6. Klik op Creëren.

Wanneer u uw API-inventaris uitbouwt, kunt u gebruikmaken van geautomatiseerde hulpprogramma's voor het registreren van API's, zoals de Azure API Center-extensie voor Visual Studio Code en de Azure CLI.

Volgende stap

Uw API-inventaris begint vorm te geven. U kunt nu informatie toevoegen over API-omgevingen en implementaties.