Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Esplorare i concetti chiave del Centro API di Azure, che consente di tenere traccia delle API in una posizione centralizzata per l'individuazione, il riutilizzo e la governance.
Modello di dati
Le entità principali in una configurazione del Centro API di Azure includono le API e le relative versioni, definizioni e distribuzioni. Gli ambienti di runtime possibili per ogni API e metadati descrittivi integrano la configurazione.
Il diagramma seguente illustra le entità principali e il modo in cui si riferiscono tra loro.
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.
È possibile gestire un'API nell'inventario da qualsiasi soluzione di gestione API. Ad esempio, usare Gestione API di Azure, Gestione API Apigee, Kong Konnect, MuleSoft API Management o un'altra piattaforma. Un'API rappresentata nel Centro API di Azure può anche essere non gestita.
I responsabili dei programmi API o gli amministratori IT possono creare e gestire l'inventario API nel Centro API di Azure. Il Centro API di Azure include anche funzionalità che consentono agli sviluppatori di API di registrare le definizioni api direttamente dai propri ambienti di sviluppo, ad esempio le pipeline CI/CD di Visual Studio Code.
Versione dell'API
Il controllo delle versioni delle API è la pratica di gestire le modifiche a un'API e garantire che le 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 potrebbero introdurre modifiche importanti o di rilievo, mentre altre aggiungono miglioramenti secondari. Una versione dell'API può essere in qualsiasi fase del ciclo di vita, dalla progettazione, all'anteprima, alla produzione o deprecata.
Definizione API
Deve essere presente almeno una definizione per ogni versione dell'API, 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.
Per semplificare la governance delle API, il Centro API di Azure offre funzionalità di linting per analizzare le definizioni delle API per la qualità e la conformità agli standard dell'organizzazione.
Ambiente
Un ambiente rappresenta una posizione in cui un runtime api è distribuibile, ad esempio un servizio Gestione API di Azure o un servizio Gestione API Apigee. È anche possibile eseguire la distribuzione in un servizio di calcolo, ad esempio un cluster Kubernetes, un'app Web o un'app funzioni 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 altre entità impostando i valori dei metadati. I metadati sono utili per la ricerca e il filtro e l'applicazione degli standard di governance. Un centro API offre diverse proprietà di metadati predefinite comuni, API type ad esempio e lifecycle stage. 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 API approver proprietà di metadati per identificare il singolo responsabile dell'approvazione di un'API da usare.
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.