Cos'è la specifica OpenAPI e perché usarla

Completato

OpenAPI definisce una descrizione dell'interfaccia standard e indipendente dal linguaggio di programmazione per le API Web. Permette sia alle persone che ai computer di scoprire e comprendere le capacità di un servizio senza dover accedere al codice sorgente, a documentazione aggiuntiva o ad analisi del traffico di rete.

Screenshot di OpenAPI.

Usando un documento OpenAPI che descrive un'API Web, il consumatore può comprendere e comunicare con l'API Web con il minimo sforzo.

È possibile creare un connettore personalizzato per qualsiasi API Web purché sia descritto correttamente da un documento OpenAPI. Ciò significa che il team di sviluppo fusion di VanArsdel non si limita a creare connettori personalizzati per le proprie applicazioni Power Apps da API Web ospitate in Gestione API di Azure.

Cosa fa il documento OpenAPI?

Il documento OpenAPI specifica un contratto relativo alla superficie dell'API Web. Evita che il consumatore dell'API si occupi delle specifiche dell'implementazione effettiva. Ciò significa che è possibile creare rapidamente l'applicazione sapendo quali metodi chiamare e cosa restituiscono senza doversi preoccupare del come vengano richiamati.

Nell'unità precedente si è usata Gestione API di Azure per creare un connettore personalizzato. Nell'ambito del processo, è stata creata anche una dipendenza da Gestione API di Azure. In altre parole, se viene apportata una modifica in Gestione API di Azure, il connettore personalizzato deve essere aggiornato per riflettere la modifica.

Con il documento OpenAPI, non occorre sapere dove si trova l'API o se è in esecuzione, perché il documento contiene tutte le informazioni necessarie.

Power Apps consente di creare istantaneamente un connettore personalizzato con questo documento OpenAPI.

Screenshot di I diversi modi per creare un connettore personalizzato.

Dopo aver creato il connettore personalizzato dal documento OpenAPI, il connettore è visibile sulla pagina di Power Apps.

Screenshot della pagina Connettore personalizzato in Power Apps.

Perché usare un documento OpenAPI per i connettori personalizzati?

L'uso del documento OpenAPI per la creazione del connettore personalizzato offre molti vantaggi, ma i due descritti di seguito sono particolarmente importanti per i citizen developer.

  • Rimozione delle dipendenze: con un documento OpenAPI è possibile creare autonomamente un connettore personalizzato, senza dover attendere che lo facciano altri con Gestione API. Inoltre, i team di sviluppo professionisti includono sempre più spesso funzionalità di generazione dei documenti OpenAPI all'interno della stessa API Web. Ciò significa che è possibile scaricare il documento OpenAPI visitando un URL e usarlo per creare il connettore personalizzato.
  • Aumento dell'agilità: la cadenza dello sviluppo di Power App aumenta quando il team di sviluppo dell'API Web può fornire un documento OpenAPI. Non è necessario rivolgersi ulteriormente al team per creare e usare un connettore personalizzato.

Come è possibile vedere nel diagramma seguente, il documento OpenAPI non deve conoscere l'effettiva implementazione dell'API Web, a condizione che il contratto rimanga lo stesso.

Diagramma di OpenAPI senza informazioni sull'API Web.

Connettore personalizzato creato con un documento OpenAPI o con Gestione API di Azure

Per creare un connettore personalizzato, è possibile usare Gestione API di Azure o un documento OpenAPI. Quale scegliere?

Questa tabella confronta alcuni aspetti di Gestione API di Azure e OpenAPI per i connettori personalizzati.

Connettore Gestione API di Azure Documento di OpenAPI
Controllo API Centralizzato Distribuito
Livello struttura API Complesso Semplice
Livello di sicurezza aggiuntivo No
Controllo utilizzo No
Costi extra No
Complessità dell'architettura Maggiore Minore