Esercitazione: Registrare le API nell'inventario API
In questa esercitazione avviare l'inventario DELLE API nel Centro API dell'organizzazione registrando le API e assegnando metadati usando il portale di Azure.
Per informazioni di base sulle API, le versioni delle API, le definizioni e altre entità che è possibile inventariare nel Centro API di Azure, vedere Concetti chiave.
In questa esercitazione si apprenderà come usare il portale per:
- Registrare una o più API
- Aggiungere una versione dell'API con una definizione API
Prerequisiti
Un centro API nella sottoscrizione di Azure. Se non ne è già stato creato uno, vedere Avvio rapido: Creare il centro API.
Una o più API da registrare nel centro API. Ecco due esempi, con collegamenti alle relative definizioni OpenAPI:
Completare l'esercitazione precedente Definire metadati personalizzati per definire metadati personalizzati per le API.
Registrare le API
Quando si registra (aggiungi) un'API nel centro API, la registrazione api include:
- Titolo (nome), tipo e descrizione
- Informazioni sulla versione
- Collegamenti facoltativi alla documentazione e ai contatti
- Metadati predefiniti e personalizzati definiti
Dopo aver registrato un'API, è possibile aggiungere versioni e definizioni all'API.
I passaggi seguenti registrano due API di esempio: API Swagger Petstore e API Conferenza (vedere Prerequisiti). Se si preferisce, registrare le API personalizzate.
Nel portale, passare al centro API.
Nel menu a sinistra, in Asset selezionare API>+ Registra un'API.
Nella pagina Registra un'API aggiungere le informazioni seguenti per l'API Swagger Petstore. Nella parte inferiore della pagina verranno visualizzati i metadati line-of-business personalizzati e pubblici definiti nell'esercitazione precedente.
Impostazione valore Descrizione Titolo DELL'API Immettere L'API Swagger Petstore. Nome scelto per l'API. Identificazione Dopo aver immesso il titolo precedente, il Centro API di Azure genera questo identificatore, che è possibile eseguire l'override. Nome della risorsa di Azure per l'API. Tipo di API Selezionare REST nell'elenco a discesa. Tipo di API. Riepilogo Facoltativamente, immettere un riepilogo. Descrizione di riepilogo dell'API. Descrizione Immettere facoltativamente una descrizione. Descrizione dell'API. Versione Titolo della versione Immettere un titolo di versione preferito, ad esempio v1. Nome scelto per la versione dell'API. Identificazione della versione Dopo aver immesso il titolo precedente, il Centro API di Azure genera questo identificatore, che è possibile eseguire l'override. Nome della risorsa di Azure per la versione. Ciclo di vita della versione Effettuare una selezione dall'elenco a discesa, ad esempio Test o Produzione. Fase del ciclo di vita della versione dell'API. Documentazione esterna Facoltativamente, aggiungere uno o più collegamenti alla documentazione esterna. Nome, descrizione e URL della documentazione per l'API. Licenza Facoltativamente, aggiungere informazioni sulla licenza. Nome, URL e ID di una licenza per l'API. Informazioni contatto Facoltativamente, aggiungere informazioni per uno o più contatti. Nome, indirizzo di posta elettronica e URL di un contatto per l'API. Line-of-business Se questi metadati sono stati aggiunti nell'esercitazione precedente, effettuare una selezione dall'elenco a discesa, ad esempio Marketing. Metadati personalizzati che identificano la business unit proprietaria dell'API. Pubblico Se sono stati aggiunti questi metadati, selezionare la casella di controllo. Metadati personalizzati che identificano se l'API è pubblica o solo interna. 
Seleziona Crea. L'API è registrata.
Ripetere i tre passaggi precedenti per registrare un'altra API, ad esempio l'API Conference.
Suggerimento
Quando si registra un'API nel portale, è possibile selezionare uno dei tipi di API predefiniti o immettere un altro tipo di opzione.
Le API vengono visualizzate nella pagina API del portale. Dopo aver aggiunto un numero elevato di API al centro API, usare la casella di ricerca e i filtri in questa pagina per trovare le API desiderate.
Dopo aver registrato un'API, è possibile visualizzare o modificare le proprietà dell'API. Nella pagina API selezionare l'API per visualizzare le pagine per gestire la registrazione api.
Aggiungere una versione dell'API
Nel corso del ciclo di vita, un'API potrebbe avere più versioni. È possibile aggiungere una versione a un'API esistente nel centro API, facoltativamente con un file o file di definizione.
Qui si aggiunge una versione a una delle API:
Nel portale, passare al proprio centro API.
Nel menu a sinistra selezionare API e quindi selezionare un'API, ad esempio Swagger Petstore.
Nella pagina API, in Dettagli, selezionare Versioni>+ Aggiungi versione.
Nella pagina Aggiungi versione DELL'API:
Immettere o selezionare le informazioni seguenti:
Impostazione valore Descrizione Titolo della versione Immettere un titolo di versione preferito, ad esempio v2. Nome scelto per la versione dell'API. Identificazione della versione Dopo aver immesso il titolo precedente, il Centro API di Azure genera questo identificatore, che è possibile eseguire l'override. Nome della risorsa di Azure per la versione. Ciclo di vita della versione Effettuare una selezione dall'elenco a discesa, ad esempio Produzione. Fase del ciclo di vita della versione dell'API. Seleziona Crea. Viene aggiunta la versione.
Aggiungere una definizione alla versione
In genere si vuole aggiungere una definizione API alla versione dell'API. Centro API di Azure supporta le definizioni in formati di specifiche di testo comuni, ad esempio OpenAPI 2 e 3 per le API REST.
Per aggiungere una definizione API alla versione:
Nella pagina Versioni dell'API selezionare la versione dell'API.
Nel menu a sinistra della versione dell'API, in Dettagli selezionare Definizioni>+ Aggiungi definizione.
Nella pagina Aggiungi definizione :
Immettere o selezionare le informazioni seguenti:
Impostazione valore Descrizione Title Immettere un titolo di propria scelta, ad esempio v2 Definition. Nome scelto per la definizione dell'API. Identificazione Dopo aver immesso il titolo precedente, il Centro API di Azure genera questo identificatore, che è possibile eseguire l'override. Nome della risorsa di Azure per la definizione. Descrizione Immettere facoltativamente una descrizione. Descrizione della definizione dell'API. Nome specifica Per l'API Petstore selezionare OpenAPI. Formato di specifica per l'API. Versione specifica Immettere un identificatore di versione di propria scelta, ad esempio 3.0. Versione specifica. Documento Passare a un file di definizione locale per l'API Petstore oppure immettere un URL. URL di esempio: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yamlFile di definizione DELL'API. 
Seleziona Crea. La definizione viene aggiunta.
In questa esercitazione si è appreso come usare il portale per:
- Registrare una o più API
- Aggiungere una versione dell'API con una definizione API
Durante la compilazione dell'inventario API, sfruttare gli strumenti automatizzati per registrare le API, ad esempio l'estensione Centro API di Azure per Visual Studio Code e l'interfaccia della riga di comando di Azure.
Passaggi successivi
L'inventario API sta iniziando a prendere forma. È ora possibile aggiungere informazioni sugli ambienti e le distribuzioni api.