Delen via

Metagegevens gebruiken voor API-governance

  • Artikel

Dit artikel bevat achtergrondinformatie over metagegevens en hoe u deze kunt gebruiken voor API-governance in Azure API Center. U definieert en stelt metagegevens in om API's en andere entiteiten in uw API-centrum te ordenen en te filteren. Metagegevens kunnen worden ingebouwd of aangepast en u kunt een metagegevensschema ontwikkelen om consistentie af te dwingen in uw API's, omgevingen en implementaties.

Ingebouwde metagegevens

Wanneer u API's, omgevingen en implementaties in uw API-centrum maakt of bijwerkt, stelt u bepaalde ingebouwde metagegevenseigenschappen in, zoals het API-type (REST, WSDL, enzovoort).

De volgende tabellen bevatten ingebouwde metagegevens die zijn opgegeven voor Azure API Center-entiteiten. Zie de NAslaginformatie over de REST API van API Center voor meer informatie. Tabellen bevatten geen standaardEigenschappen van Azure, zoals resource-id's, weergavetitels en beschrijvingen. Niet alle eigenschappen zijn vereist.

API's

Metagegevens Beschrijving Voorbeeldwaarden
soort soort (type) van API REST, SOAP, GraphQL
levenscyclusfase fase van de levenscyclus van API-ontwikkeling ontwerp, ontwikkeling
licentie licentiegegevens voor de API SPDX-id, koppeling naar licentietekst
externe documentatie site voor externe documentatie voor de API URL die verwijst naar documentatie
contactgegevens contactpunten voor de API e-mailadres, naam, URL
servicevoorwaarden servicevoorwaarden voor de API URL die verwijst naar servicevoorwaarden

Omgevingen

Metagegevens Beschrijving Voorbeeldwaarden
soort soort (type) omgeving productie, fasering, ontwikkeling
server servergegevens van de omgeving type en URL die verwijst naar de omgevingsserver
servertype type omgevingsserver API Management-server, Kubernetes-server, Apigee-server
onboarden onboarding-informatie voor de omgeving instructies en URL die verwijst naar de ontwikkelaarsportal van de omgeving

Installaties

Metagegevens Beschrijving Voorbeeldwaarden
server servergegevens van de implementatie URL die verwijst naar de implementatieserver
staat status van de implementatie actief, inactief

Aangepaste metagegevens

Definieer aangepaste metagegevens met behulp van De Azure-portal, de REST API van Azure API Center of de Azure CLI om API's, omgevingen en implementaties in uw API-centrum te organiseren en te filteren. Azure API Center ondersteunt aangepaste metagegevens van de volgende typen.

Type Description Voorbeeldnaam
boolean waar of onwaar IsInternal
Nummer numerieke waarde YearOfCreation
tekenreeks tekstwaarde GitHubRepository
matrix lijst met waarden Tags
ingebouwde keuze ingebouwde lijst met keuzes Departement
object complex object samengesteld uit meerdere typen APIApprover

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.

Metagegevens toewijzen aan entiteiten

Aangepaste metagegevenseigenschappen kunnen worden toegewezen aan API's, omgevingen of implementaties in uw API-centrum. Definieer en wijs bijvoorbeeld afdelingsmetagegevens toe aan API's, zodat wanneer een API wordt geregistreerd of een nieuwe API-versie wordt toegevoegd, de afdeling die verantwoordelijk is voor de API wordt opgegeven.

Als deze is toegewezen aan een entiteit, zijn metagegevens optioneel of vereist. U moet bijvoorbeeld vereisen dat de metagegevens van de afdeling alleen zijn ingesteld voor API's, maar dat YearOfCreation optionele metagegevens voor omgevingen is.

Notitie

  • Definieer op elk gewenst moment aangepaste metagegevens en pas deze toe op API's en andere entiteiten in uw API-centrum.
  • Nadat u aangepaste metagegevens hebt gedefinieerd, kunt u de toewijzing ervan wijzigen in een entiteit, bijvoorbeeld van vereist naar optioneel voor API's.
  • U kunt metagegevenswaarden wijzigen, maar u kunt het type aangepaste metagegevens dat momenteel is ingesteld in API's, omgevingen en implementaties niet verwijderen of wijzigen. Wijs eerst de aangepaste metagegevens van de entiteiten in en vervolgens kunt u ze verwijderen of wijzigen.

Metagegevens gebruiken voor governance

Gebruik ingebouwde en aangepaste metagegevens om uw API's, omgevingen en implementaties in uw API-centrum te organiseren. Voorbeeld:

  • Governancestandaarden in uw organisatie afdwingen door te vereisen dat bepaalde metagegevens worden ingesteld voor API's, omgevingen en implementaties.

  • Zoek en filter API's in uw API-centrum op metagegevenswaarden. U kunt rechtstreeks filteren op de pagina API's in Azure Portal, of de REST API van Azure API Center of Azure CLI gebruiken om query's uit te voeren op API's op basis van waarden van bepaalde metagegevens.

    Schermopname van het filteren van API's in de portal.

Gerelateerde inhoud