Informazioni sulla progettazione API personalizzata

In Oracle Mobile Hub è possibile creare interfacce API REST personalizzate che possono essere utilizzate dalle applicazioni Mobile.

Se si è sviluppatori di applicazioni Mobile, utilizzare API Designer per progettare e sottoporre a test gli endpoint definiti, quindi chiedere a uno sviluppatore di servizi di compilare i dettagli dell'API (aggiungere tipi di risorse o caratteristiche, fornire uno schema e impostare l'accesso all'API e ai relativi endpoint) e implementarla in JavaScript. Se sei uno sviluppatore di servizi, utilizza API Designer per configurare in modo esplicito un'API completa che puoi testare con dati mock. In alternativa, puoi generare API personalizzate da connettori REST o Fusion Applications senza scrivere codice.

A differenza delle API della piattaforma Oracle Mobile Hub, che forniscono un set di base di servizi noti, le API personalizzate consentono di utilizzare Node.js per codificare qualsiasi servizio di cui l'applicazione mobile ha bisogno, pubblicato tramite un'interfaccia REST. È possibile trasmettere i dati utilizzando un connettore Oracle Mobile Hub a un servizio backend, che trasforma i dati complessi in payload compatibili con il dispositivo mobile. Utilizzando le API personalizzate per creare un catalogo di servizi riutilizzabili, è possibile risparmiare molto tempo che altrimenti potrebbe essere impiegato periodicamente per ricreare e gestire i dettagli di implementazione nelle applicazioni mobile.

Informazioni sul processo di progettazione API

API Designer assiste l'utente nel processo di creazione di un'interfaccia API personalizzata.

È possibile creare rapidamente una versione bozza dell'API in pochi passi:

Aggiungere le nozioni di base (nome dell'interfaccia API, tipo di supporto per i messaggi e una breve descrizione).
Definire un endpoint impostando una risorsa e almeno un metodo per tale risorsa.
Impostare la sicurezza dell'accesso.
Eseguire il test dell'endpoint dopo aver definito almeno una risorsa.

Puoi creare dati mock per testare e convalidare rapidamente un endpoint anche quando non hai completato completamente la configurazione dell'API. Quando si definisce il corpo del messaggio, è possibile fornire valori segnaposto per verificare l'invio o la restituzione dei dati corretti.

Per completare completamente l'API, utilizzare API Designer per aggiungere i componenti essenziali per un'API affidabile:

Fornire i metadati API (ovvero gli attributi di base dell'API, ovvero il nome visualizzato dell'API, il nome dell'API e la descrizione breve) oppure, se si dispone già di un documento RAML contenente la configurazione dell'API, è possibile caricarlo in API Designer. Tutte le informazioni (metadati, risorse, metodi e schema per il corpo del messaggio) vengono estratte dal documento RAML e caricate in API Designer, consentendo di procedere rapidamente al test degli endpoint o alla modifica della configurazione API.
Aggiungere una o più risorse radice e nidificate.
Aggiungere metodi per agire sulle risorse.
Creare uno schema per descrivere il corpo dei dati.
Testare gli endpoint durante la fase di progettazione con dati di esempio e apportare le modifiche necessarie.
Consente l'accesso anonimo all'API o specifica quali ruoli possono accedervi.
Aggiungi documentazione per la tua API personalizzata

In seguito, quando si creano più API, è possibile che si stiano definendo ripetutamente gli stessi metodi e che si utilizzino gli stessi parametri e così via. È possibile ridurre la ridondanza creando tipi e caratteristiche di risorse. Se l'interfaccia API è ancora in stato Bozza, è possibile tornare alla configurazione e aggiungere i tipi e le caratteristiche delle risorse definiti.

Informazioni sulla generazione di interfacce API personalizzate per i connettori

Oracle Mobile Hub può generare codice personalizzato dai connettori per connettersi a servizi esterni. Gli sviluppatori di servizi possono selezionare un connettore Oracle Fusion Applications o un connettore REST creato con un descrittore valido, generare l'API personalizzata e utilizzare l'API generata per semplificare la chiamata a questi servizi dalle implementazioni delle API personalizzate o direttamente da un'applicazione mobile.

Un connettore consente a un backend mobile di comunicare con un servizio esterno, ad esempio un sistema enterprise o API di terze parti, che a sua volta consente a un'applicazione mobile di interagire con le funzioni di tale servizio. Un'interfaccia API connettore è una configurazione per la comunicazione con un servizio esterno specifico per l'invio e la ricezione dei dati.

Gli sviluppatori di servizi possono generare un'interfaccia API personalizzata che espone i metodi di un'interfaccia API connettore e fornisce un'implementazione predefinita senza scrivere codice.

L'interfaccia API personalizzata viene generata con un endpoint per ogni risorsa nell'interfaccia API connettore ed è aperta in API Designer per consentire di continuare a specificare i dettagli dell'interfaccia API, ad esempio i ruoli. Anche l'implementazione predefinita, che passa attraverso tutte le richieste provenienti dall'API personalizzata generata all'API connettore di destinazione, viene generata e assegnata all'API generata. Non appena sono stati assegnati ruoli all'API se sono necessari per la sicurezza sul connettore, è possibile utilizzare l'implementazione per eseguire il test dell'API. È possibile scaricare e modificare l'implementazione, quindi caricarla.

Essere in grado di creare un'API personalizzata per un connettore significa che è molto più facile creare un prototipo che si utilizza per testare un connettore. Quando trovi le modifiche che desideri apportare, puoi apportare rapidamente una modifica al connettore e generare una nuova API e implementazione personalizzata. Una volta soddisfatti, è possibile generare una versione finale dell'API personalizzata e dell'implementazione.

Sviluppare un connettore REST o un connettore Oracle Fusion Cloud Applications definito mediante un descrittore.
Generare l'interfaccia API personalizzata dal connettore. Viene aperto in API Designer, dove è possibile definire uno o più ruoli o specificare l'autenticazione richiesta dall'API.
È possibile chiamare immediatamente l'API generata dal dispositivo mobile. L'implementazione predefinita passa attraverso tutte le richieste provenienti dall'API generata all'API del connettore di destinazione.
È probabile che si desideri scaricare l'implementazione e modificarla per modellare i dati restituiti.
È possibile rivedere il connettore e apportare modifiche alle risorse o al descrittore del connettore. In tal caso, è necessario generare una nuova API e implementazione personalizzata. Se si apportano modifiche all'API personalizzata generata, queste modifiche non vengono applicate al connettore. È necessario apportare le modifiche appropriate nel connettore, quindi generare di nuovo l'API personalizzata e l'implementazione.

È possibile generare solo un'interfaccia API personalizzata per un connettore REST o Oracle Fusion Cloud Applications, definito mediante un descrittore. Impossibile generare un'interfaccia API personalizzata per un altro tipo di connettore o in cui il connettore REST o Oracle Fusion Cloud Applications non dispone di un descrittore.

Se si desidera inviare dati di form multiparte o utilizzare l'oggetto opzioni http, potrebbe essere necessario sostituire il metodo callConnector nell'implementazione con un codice personalizzato.

API connettore REST

È possibile creare interfacce API connettore per connettersi ai servizi REST esterni. È quindi possibile chiamare queste interfacce API connettore dalle implementazioni delle interfacce API personalizzate.

Funzionamento delle API connettore REST

Un'API connettore REST è un'API intermedia per la chiamata degli endpoint REST nei sistemi enterprise o nelle API di terze parti. L'API connettore assume la forma di una configurazione che offre alle applicazioni un modo standard per connettersi a questi servizi REST e sfruttare la sicurezza, la diagnostica e altre funzioni offerte da Oracle Mobile Hub.

Il connettore comunica e passa le informazioni tra il client e il server utilizzando il protocollo HTTPS. Le informazioni passate possono essere in formato XML o JSON (ma solo in JSON per i servizi basati su descrittori Swagger).

La procedura guidata API connettore REST consente di creare le API del connettore REST, dalla specifica di un servizio remoto all'impostazione dei criteri di sicurezza per eseguire il test degli endpoint.

Perché utilizzare i connettori anziché le chiamate dirette alle risorse esterne?

L'uso di un'interfaccia API connettore REST offre i vantaggi riportati di seguito rispetto alle chiamate dirette dal codice dell'applicazione alle risorse esterne.

Consente la configurazione semplificata dei criteri e della connessione dichiarativa.
Con un descrittore Swagger, determina le risorse disponibili e crea automaticamente gli endpoint.
Fornisce informazioni diagnostiche complete in quanto è strettamente integrata con il framework di diagnostica di Oracle Mobile Hub. Tutte le chiamate REST in uscita effettuate tramite le API connettore vengono registrate, il che è molto utile per il debug.
Consente il tracciamento e l'analisi sull'uso remoto dell'API.
Consente di definire l'interazione con il servizio in fase di progettazione quando si testa la validità degli endpoint in modo che i termini di tale interazione non dipendano dall'input dell'utente in fase di runtime. Ciò protegge sia il sistema finale che il backend mobile da eventuali danni.
Fornisce un approccio di progettazione coerente tra più tipi di connettore per l'interazione con i servizi esterni.
Con qualsiasi modifica all'interfaccia per un servizio, puoi gestire tutti gli aggiornamenti, i test e la migrazione necessari in un'unica posizione.