API Rest OpenAPI

Le OpenAPI di Jamio openwork consentono di utilizzare tutte le funzionalità applicative della piattaforma tramite API REST descritte secondo lo standard OpenAPI. E’ possibile così integrare con Jamio applicazioni terze oppure creare applicazioni di front-end che utilizzano la potenza delle API Jamio openwork per eseguire la propria logica di business.

OpenAPI consente di integrare le API Jamio openwork generando automaticamente il codice di integrazione tramite il tool scaricabile al seguente indirizzo. Il tool è una versione dello strumento Swagger-codgen modificato per consentire la rappresentazione dei tipi enumerativi di Jamio openwork in C# o Java. Per altri linguaggi di programmazione è necessario integrare delle classi rappresentative dei tipi sopra indicati.

Nella codice di integrazione generato automaticamente le classi che descrivono le entità modellabili ad hoc e quindi nella classe nel client, il nome della classe che descrive la specifica versione del modello è dato dal nome del modello e dal codice hash che riflette l’impronta della versione di quel modello.

I Servizi Jamio per la gestione dei dati e dei processi sono general purpose: tramite il tool Jamio Composer vengono configurati per gestire specifiche strutture dati e assolvere a funzionalità applicative di dominio. Tramite OpenAPI è possibile generare codice di integrazione general purpose oppure codice di integrazione ad hoc per gestire specifici tipi personalizzati.

Il codice general purpose è utile, per esempio, per salvare una qualsiasi struttura dati: è lasciato all’integratore il compito di specificare i campi che compongono la struttura dati; a scapito di una maggiore riutilizzabilità del codice l’integratore ha maggiore possibilità di sbagliare e ha la necessità di conoscere la struttura dei modelli definiti dal progettista.

Ad esempio, se il progettista ha definito un tipo denominato Anagrafica Cliente con campi specifici, il codice ad hoc conterrà esattamente i campi dell’Anagrafica Cliente: l’integratore non ha la necessità di conoscere la struttura dei modelli definiti dal progettista, la definizione è riportata nel codice creato.

Per la documentazione relativa alle OpenAPI di Jamio openwork clicca QUI.

Per scaricare lo swagger dei servizi utile alla generazione del codice general purpose utilizza l’indirizzo https://paas.jamio.com/openapi/swagger/docs/V1 .

Per costruire ed utilizzare un client delle API REST in linguaggio Java o C# occorre effettuare i seguenti passaggi:

1.Generare il descrittore swagger che rappresenta la modellazione del dominio applicativo;

2.Generare il client con il tool Swagger-codgen;

3.Utilizzare il client per costruire la propria applicazione software.