Indipendentemente che si voglia erogare o fruire un servizio, è necessario iniziare il processo di configurazione con il censimento delle relative API. Questa operazione si effettua sulla govwayConsole posizionandosi nella sezione Registro > API.
La pagina di ingresso mostra l'elenco delle API eventualmente già presenti in configurazione. Ciascun elemento dell'elenco riporta l'identificativo, il tipo SOAP o REST e il formato del descrittore fornito in configurazione (apiList).
Elenco delle API
Gli elementi dell'elenco possono essere selezionati per l'eliminazione, con il pulsante Elimina, e per l'esportazione, con il pulsante Esporta. La funzione di esportazione è descritta nella sezione esporta.
Note
Icona di Stato
Le API in elenco sono visualizzate con un'icona colorata affiancata al nome. L'icona di colore rosso indica un problema nella configurazione e quindi l'inutilizzabilità della API. L'icona gialla indica il parziale utilizzo limitato agli elementi configurati correttamente. L'icona verde indica la piena funzionalità.
Note
Tags
A fianco del nome della API, in alcuni casi, è mostrato l'elenco dei tag associati a scopo di classificazione.
Si crea una nuova API premendo il pulsante Aggiungi.
Definizione di una API
Compilare il form (apiNew) inserendo i seguenti dati:
- Tipo: Selezionare il tipo delle API a scelta tra "Soap" e "Rest".
- Nome: Assegnare un nome che identifichi le API.
- Descrizione: un testo opzionale di descrizione.
- Tags: un elenco di tag da associare all'API per classificarla. Iniziando a scrivere, vengono proposti i tag già esistenti compatibili.
- Versione: progressivo numerico che identifica l'indice di revisione.
Specifica delle Interfacce: In questa sezione è possibile caricare il descrittore formale dell'interfaccia, analizzando il quale, il gateway produce la corrispondente configurazione. Nel caso di interfacce Soap si potrà caricare il relativo WSDL. Nel caso di interfacce Rest si potrà scegliere tra i formati: WADL, Swagger 2.x e OpenAPI 3.3.
Nel caso non si disponga del descrittore dell'interfaccia è sempre possibile inserire manualmente la relativa configurazione seguendo le modalità descritte alla sezione
confManuale.
Effettuato il salvataggio, l'API sarà consultabile all'interno dell'elenco delle API registrate. Accedendo al dettaglio si potranno visionare, a seconda del tipo di API SOAP o REST, rispettivamente i servizi o le risorse che tale API dispone. Nella figura risorseAPI_fig viene riporta l'elenco delle risorse di una API REST.
Risorse di una API REST
