Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of mappen te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen om mappen te wijzigen.
Verken de belangrijkste concepten van Azure API Center, waarmee u API's kunt bijhouden op een centrale locatie voor detectie, hergebruik en governance.
Gegevensmodel
De belangrijkste entiteiten in een Azure API Center-configuratie omvatten uw API's en hun versies, definities en implementaties. De mogelijke runtime-omgevingen voor elke API en beschrijvende metagegevens vormen een aanvulling op de configuratie.
In het volgende diagram ziet u de belangrijkste entiteiten en hoe ze zich met elkaar verhouden.
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.
U kunt een API in de inventaris beheren door elke API-beheeroplossing. Gebruik bijvoorbeeld Azure API Management, Apigee API Management, Kong Konnect, MuleSoft API Management of een ander platform. Een API die wordt weergegeven in Azure API Center, kan ook onbeheerd zijn.
API-programmabeheerders of IT-beheerders kunnen de API-inventaris maken en beheren in Azure API Center. Azure API Center bevat ook functies voor API-ontwikkelaars om API-definities rechtstreeks vanuit hun ontwikkelomgevingen te registreren, zoals Visual Studio Code of CI/CD-pijplijnen.
API-versie
API-versiebeheer is de praktijk van het beheren van wijzigingen in een API en ervoor zorgen dat de 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 ingrijpende wijzigingen vertonen, terwijl andere kleine verbeteringen toevoegen. Een API-versie kan zich in elke levenscyclusfase bevinden, van ontwerp, tot preview, productie of afgeschaft.
API-definitie
Er moet ten minste één definitie zijn voor elke API-versie, 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.
Voor hulp bij API-governance biedt Azure API Center lintingmogelijkheden voor het analyseren van API-definities voor kwaliteit en naleving van organisatiestandaarden.
Omgeving
Een omgeving vertegenwoordigt een locatie waar een API-runtime kan worden geïmplementeerd, zoals een Azure API Management-service of een Apigee API Management-service. U kunt ook implementeren in een rekenservice, zoals een Kubernetes-cluster, web-app of Azure Functions-app. 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 ze 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 uw API's, implementaties en andere entiteiten in Azure API Center door metagegevenswaarden in te stellen. De metagegevens zijn handig voor het zoeken en filteren en afdwingen van governancestandaarden. Een API-centrum biedt verschillende algemene ingebouwde metagegevenseigenschappen zoals API type en lifecycle stage. 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 API approver eigenschap voor metagegevens 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.