Azure API Center - belangrijkste concepten
In dit artikel worden de belangrijkste concepten van Azure API Center uitgelegd. Met Azure API Center kunt u API's bijhouden op een centrale locatie voor detectie, hergebruik en governance.
Gegevensmodel
In het volgende diagram ziet u de belangrijkste entiteiten in Azure API Center en hoe ze zich met elkaar verhouden. Zie de volgende secties voor meer informatie over deze entiteiten en gerelateerde concepten.
API
Een logische entiteit op het hoogste niveau in Azure API Center, een API vertegenwoordigt elke echte API die u wilt bijhouden. Een API-centrum kan API's van elk type bevatten, waaronder REST, GraphQL, gRPC, SOAP, WebSocket en Webhook.
Een API kan worden beheerd door elke API Management-oplossing (zoals Azure API Management of oplossingen van andere providers) of onbeheerd.
De API-inventaris in Azure API Center is ontworpen om te worden gemaakt en beheerd door API-programmabeheerders of IT-beheerders.
API-versie
API-versiebeheer is de praktijk van het beheren van wijzigingen in een API en ervoor zorgen dat deze wijzigingen worden aangebracht zonder clients te verstoren. Een API kan meerdere versies in levenscyclusfasen hebben, die elk zijn afgestemd op specifieke API-wijzigingen. Sommige versies kunnen belangrijke of belangrijke wijzigingen veroorzaken, terwijl andere kleine verbeteringen toevoegen. Een API-versie kan zich in elke levenscyclusfase bevinden, van ontwerp, tot preview, productie of afgeschaft.
API-definitie
Elke API-versie moet idealiter worden gedefinieerd met ten minste één definitie, zoals een OpenAPI-definitie voor een REST API. Azure API Center staat elk API-definitiebestand toe dat is opgemaakt als tekst (YAML, JSON, Markdown, enzovoort). U kunt onder andere OpenAPI-, gRPC-, GraphQL-, AsyncAPI-, WSDL- en WADL-definities uploaden.
Omgeving
Een omgeving vertegenwoordigt een locatie waar een API-runtime kan worden geïmplementeerd, bijvoorbeeld een Azure API Management-service, een Apigee API Management-service of een rekenservice zoals een Kubernetes-cluster, een web-app of een Azure-functie. Elke omgeving is afgestemd op een levenscyclusfase, zoals ontwikkeling, testen, fasering of productie. Een omgeving kan ook informatie bevatten over de ontwikkelaarsportal of beheerinterfaces.
Notitie
Gebruik Azure API Center om een van uw API-runtimeomgevingen bij te houden, ongeacht of deze worden gehost in de Azure-infrastructuur. Deze omgevingen zijn niet hetzelfde als Azure Deployment Environments.
Implementatie
Een implementatie is een locatie (een adres) waar gebruikers toegang hebben tot een API. Een API kan meerdere implementaties hebben, zoals verschillende faseringsomgevingen of regio's. Een API kan bijvoorbeeld één implementatie hebben in een interne faseringsomgeving en een seconde in een productieomgeving. Elke implementatie is gekoppeld aan een specifieke API-definitie.
Metagegevens
Organiseer in Azure API Center uw API's, implementaties en andere entiteiten door metagegevenswaarden in te stellen, die kunnen worden gebruikt voor zoeken en filteren en om governancestandaarden af te dwingen. Een API-centrum biedt verschillende algemene ingebouwde metagegevenseigenschappen, zoals 'API-type' en 'levenscyclusfase'. De eigenaar van het API-centrum kan de ingebouwde metagegevens uitbreiden door aangepaste metagegevens in een metagegevensschema te definiëren om hun API's, implementaties en omgevingen te organiseren. Maak bijvoorbeeld een eigenschap api-fiatteur om de persoon te identificeren die verantwoordelijk is voor het goedkeuren van een API voor gebruik.
Azure API Center ondersteunt aangepaste metagegevens van het type matrix, booleaanse waarde, getal, object, vooraf gedefinieerde keuzes en tekenreeksen.
Het metagegevensschema van Azure API Center is compatibel met JSON- en YAML-schemaspecificaties om schemavalidatie mogelijk te maken in hulpprogramma's voor ontwikkelaars en geautomatiseerde pijplijnen.