Azure API Center – viktiga begrepp
Den här artikeln beskriver viktiga begrepp i Azure API Center. Med Azure API Center kan du spåra API:er på en central plats för identifiering, återanvändning och styrning.
Datamodell
Följande diagram visar de viktigaste entiteterna i Azure API Center och hur de relaterar till varandra. Mer information om dessa entiteter och relaterade begrepp finns i följande avsnitt.
API
Ett API är en logisk entitet på den översta nivån i Azure API Center och representerar alla verkliga API:er som du vill spåra. Ett API-center kan innehålla API:er av vilken typ som helst, inklusive REST, GraphQL, gRPC, SOAP, WebSocket och Webhook.
Ett API i inventeringen kan hanteras av valfri API-hanteringslösning, till exempel Azure API Management, Apigee API Management, Kong Konnect, MuleSoft API Management eller någon annan plattform. Ett API som representeras i Azure API Center kan också vara ohanterat.
API-inventeringen i Azure API Center är utformad för att skapas och hanteras av API-programhanterare eller IT-administratörer.
API-version
API-versionshantering är praxis att hantera ändringar i ett API och se till att dessa ändringar görs utan att störa klienter. Ett API kan ha flera versioner i livscykelfaser, var och en i linje med specifika API-ändringar. Vissa versioner kan introducera större eller icke-bakåtkompatibla ändringar, medan andra lägger till mindre förbättringar. En API-version kan finnas i alla livscykelsteg – från design, till förhandsversion, produktion eller inaktuell.
API-definition
Varje API-version bör helst definieras av minst en definition, till exempel en OpenAPI-definition för ett REST API. Med Azure API Center kan alla API-definitionsfiler formateras som text (YAML, JSON, Markdown och så vidare). Du kan ladda upp OpenAPI-, gRPC-, GraphQL-, AsyncAPI-, WSDL- och WADL-definitioner, bland annat.
Environment
En miljö representerar en plats där en API-körning kan distribueras, till exempel en Azure API Management-tjänst, en Apigee API Management-tjänst eller en beräkningstjänst, till exempel ett Kubernetes-kluster, en webbapp eller en Azure-funktion. Varje miljö är anpassad efter ett livscykelsteg, till exempel utveckling, testning, mellanlagring eller produktion. En miljö kan också innehålla information om utvecklarportalen eller hanteringsgränssnitt.
Kommentar
Använd Azure API Center för att spåra någon av dina API-körningsmiljöer, oavsett om de finns i Azure-infrastrukturen eller inte. De här miljöerna är inte samma som Azure-distributionsmiljöer.
Distribution
En distribution är en plats (en adress) där användare kan komma åt ett API. Ett API kan ha flera distributioner, till exempel olika mellanlagringsmiljöer eller regioner. Ett API kan till exempel ha en distribution i en intern mellanlagringsmiljö och en andra i en produktionsmiljö. Varje distribution är associerad med en specifik API-definition.
Metadata
I Azure API Center organiserar du dina API:er, distributioner och andra entiteter genom att ange metadatavärden, som kan användas för sökning och filtrering och för att tillämpa styrningsstandarder. Ett API-center innehåller flera vanliga inbyggda metadataegenskaper, till exempel "API-typ" och "livscykelsteg". API Center-ägaren kan utöka de inbyggda metadata genom att definiera anpassade metadata i ett metadataschema för att organisera sina API:er, distributioner och miljöer. Skapa till exempel en API-godkännaregenskap för att identifiera den person som ansvarar för att godkänna ett API för användning.
Azure API Center stöder anpassade metadata av typen matris, booleskt värde, objekt, fördefinierade val och sträng.
Azure API Centers metadataschema är kompatibelt med JSON- och YAML-schemaspecifikationer för att möjliggöra schemavalidering i utvecklarverktyg och automatiserade pipelines.