Centro API di Azure - Concetti chiave
Questo articolo illustra i concetti chiave di Centro API di Azure. Il Centro API di Azure abilita le API di rilevamento in una posizione centralizzata per l'individuazione, il riutilizzo e la governance.
Modello di dati
Il diagramma seguente illustra le entità principali nel Centro API di Azure e il modo in cui sono correlate tra loro. Per altre informazioni su queste entità e sui concetti correlati, vedere le sezioni seguenti.
API
Un'entità logica di primo livello nel Centro API di Azure, un'API rappresenta qualsiasi API reale che si vuole tenere traccia. Nel Centro API di Azure è possibile includere API di qualsiasi tipo, tra cui REST, GraphQL, gRPC, SOAP, WebSocket e Webhook.
Un'API nell'inventario può essere gestita da qualsiasi soluzione di gestione API, ad esempio Gestione API di Azure, Gestione API Apigee, Kong Konnect, Gestione API MuleSoft o un'altra piattaforma. Un'API rappresentata nel Centro API di Azure può anche essere non gestita.
L'inventario API nel Centro API di Azure è progettato per essere creato e gestito da responsabili di programmi API o amministratori IT.
Versione dell'API
Il controllo delle versioni delle API è la pratica di gestire le modifiche apportate a un'API e di garantire che queste modifiche vengano apportate senza interrompere i client. Un'API può avere più versioni nelle varie fasi del ciclo di vita, ciascuna allineata con le modifiche specifiche dell'API. Alcune versioni possono introdurre modifiche importanti o in grado di causare un’interruzione, mentre altre aggiungono miglioramenti secondari. Una versione dell'API può trovarsi in qualsiasi fase del ciclo di vita, dalla progettazione all'anteprima, alla produzione o all'eliminazione.
Definizione API
Ogni versione dell'API deve essere definita idealmente da almeno una definizione, ad esempio una definizione OpenAPI per un'API REST. Il Centro API di Azure consente qualsiasi file di definizione API formattato come testo (YAML, JSON, Markdown e così via). È possibile caricare definizioni OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL e WADL, e altre ancora.
Ambiente
Un ambiente rappresenta una posizione in cui è possibile distribuire un runtime API, ad esempio un servizio Gestione API di Azure, un servizio Gestione API Apigee o un servizio di calcolo, ad esempio un cluster Kubernetes, un'app Web o una funzione di Azure. Ogni ambiente è allineato a una fase del ciclo di vita, ad esempio sviluppo, test, gestione temporanea o produzione. Un ambiente può includere anche informazioni sul portale per sviluppatori o sulle interfacce di gestione.
Nota
Usare Il Centro API di Azure per tenere traccia di uno degli ambienti di runtime dell'API, indipendentemente dal fatto che siano ospitati nell'infrastruttura di Azure. Questi ambienti non sono uguali a ambienti di distribuzione di Azure.
Distribuzione
Una distribuzione è una posizione (un indirizzo) in cui gli utenti possono accedere a un'API. Un'API può avere più distribuzioni, ad esempio aree o ambienti di gestione temporanea diversi. Ad esempio, un'API potrebbe avere una distribuzione in un ambiente di gestione temporanea interno e una seconda in un ambiente di produzione. Ogni distribuzione è associata a una definizione API specifica.
Metadati UFX
Nel Centro API di Azure organizzare le API, le distribuzioni e le altre entità impostando i valori dei metadati che possono essere usati per la ricerca e il filtro oltre che per applicare gli standard di governance. Un centro API fornisce diverse proprietà comuni di metadati predefinite, ad esempio "tipo di API" e "fase del ciclo di vita". Il proprietario del centro API può aumentare i metadati predefiniti definendo metadati personalizzati in uno schema di metadati per organizzare le API, le distribuzioni e gli ambienti. Ad esempio, creare una proprietà responsabile approvazione API per identificare la persona responsabile dell'approvazione di un'API.
Il Centro API di Azure supporta metadati tipo matrice, booleano, numero, oggetto, opzioni predefinite e stringa.
Lo schema dei metadati del Centro API di Azure è compatibile con le specifiche dello schema JSON e YAML, per consentire la convalida dello schema negli strumenti di sviluppo e nelle pipeline automatizzate.