Zelfstudie: Aangepaste metagegevens definiëren

In deze zelfstudie definieert u aangepaste metagegevens om uw API's en andere informatie in uw API-centrum te ordenen. Gebruik aangepaste en ingebouwde metagegevens voor zoeken en filteren en om governancestandaarden in uw organisatie af te dwingen.

Zie voor achtergrondinformatie over metagegevens in Azure API Center:

• Belangrijke concepten
• Metagegevens voor API-governance

In deze zelfstudie leert u hoe u de portal gebruikt voor het volgende:

• Aangepaste metagegevens definiëren in uw API-centrum
• Het metagegevensschema weergeven

Vereisten

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

Metagegevens definiëren

Hier definieert u twee voorbeelden van aangepaste metagegevens: Line-of-Business en Public-facing. Als u wilt, definieert u desgewenst andere metagegevens. Wanneer u API's en andere informatie in uw inventaris toevoegt of bijwerkt, stelt u waarden in voor aangepaste en algemene ingebouwde metagegevens.

Belangrijk

Neem geen gevoelige, vertrouwelijke of persoonlijke gegevens op in de titels (namen) van metagegevens die u definieert. Deze titels zijn zichtbaar in bewakingslogboeken die door Microsoft worden gebruikt om de functionaliteit van de service te verbeteren. Andere metagegevensgegevens en -waarden zijn echter uw beveiligde klantgegevens.

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

2. Selecteer in het linkermenu onder Assets metagegevens > + nieuwe metagegevens.

3. Voer op het tabblad Details informatie in over de metagegevens.

   1. Voer in Titel line-of-business in.

   2. Voer desgewenst een beschrijving in.

   3. Selecteer vooraf gedefinieerde opties en voer keuzes in, zoals Marketing, Financiën, IT, Verkoop, enzovoort. Schakel desgewenst selectie van meerdere waarden toestaan in. Selecteer Volgende.

   

4. Selecteer Vereist voor API's op het tabblad Toewijzingen. Selecteer Optioneel voor implementaties en omgevingen. (U voegt deze entiteiten toe in latere zelfstudies.) Selecteer Volgende.

   

5. Controleer op het tabblad Controleren en maken de instellingen en selecteer Maken.

   De metagegevens worden toegevoegd aan de lijst op de pagina Metagegevens .

6. Selecteer + Nieuwe metagegevens om nog een voorbeeld toe te voegen.

7. Voer op het tabblad Details informatie in over de metagegevens.

   1. Voer in Titel een openbaar gezicht in.

   2. Selecteer Het type Booleaanse waarde.

8. Selecteer Vereist voor API's op het tabblad Toewijzingen. Selecteer Niet van toepassing op implementaties en omgevingen.

9. Controleer op het tabblad Controleren en maken de instellingen en selecteer Maken.

   De metagegevens worden toegevoegd aan de lijst.

Metagegevensschema weergeven

U kunt het JSON-schema bekijken en downloaden voor de metagegevens die zijn gedefinieerd in uw API-centrum. Het schema bevat ingebouwde en aangepaste metagegevens.

1. Selecteer in het linkermenu onder Assets het metagegevensschema voor > metagegevensweergave.

2. Selecteer Schema-API's> voor metagegevens weergeven om het metagegevensschema voor API's weer te geven, waaronder ingebouwde en aangepaste metagegevens. U kunt ook het metagegevensschema bekijken dat is gedefinieerd voor implementaties en omgevingen in uw API-centrum.

   

Volgende stappen

In deze zelfstudie hebt u geleerd hoe u de portal gebruikt voor het volgende:

• Aangepaste metagegevens definiëren in uw API-centrum
• Het metagegevensschema weergeven

Nu u uw metagegevensschema hebt voorbereid, voegt u API's toe aan de inventaris in uw API-centrum.

API's registreren in uw API-inventaris