La OpenAPI Specification, precedentemente nota come Swagger Specification, è una specifica per file di interfaccia leggibili dalle macchine per descrivere, produrre, consumare e visualizzare web service RESTful. Inizialmente parte del framework Swagger, è diventata un progetto separato nel 2016, gestito dall'OpenAPI Initiative, un progetto di collaborazione open source della Linux Foundation. Swagger e altri strumenti possono generare codice, documentazione e casi di test a partire da un file di interfaccia.
Le applicazioni implementate basandosi su file di interfaccia OpenAPI possono generare automaticamente la documentazione di metodi, parametri e modelli. Questo aiuta a mantenere allineati documentazione, librerie client e codice sorgente.
È stato rilasciato un nuovo WebService OpenAPI (attualmente in BETA) che legge la OpenAPI 3.0 Specification in formato JSON e crea automaticamente un client Delphi in codice Pascal nativo. Il WebService crea una demo che mostra come interagire con l'API.
Il WebService richiede che la specifica sia 3.0+ e in formato JSON.
Importazione della specifica OpenAPI
Il primo passo è importare la specifica openAPI 3.0; per farlo userò una semplice specifica openAPI usata da abstractapi.com per recuperare la posizione di un indirizzo IP. Qui sotto trovi il file di specifica:
Una volta che hai la specifica openAPI 3.0 in formato JSON, puoi generare i file Delphi richiesti usando il nostro WebService OpenAPI; vai al seguente URL:
https://www.esegece.com/products/openapi/ws/demo
Imposta il classname (per impostazione predefinita sarà TsgcOpenAPI_Test) e carica il file di specifica (prima decomprimilo!!!, deve essere in formato JSON). Infine premi il pulsante Upload per processare il file.
Se il processo va a buon fine, sarà scaricato un nuovo file compresso con una demo compilata.
Test della demo openAPI
Prima di testare la demo, devi creare un account gratuito su abstractapi.com per ottenere una API Key.
https://app.abstractapi.com/users/signup
Decomprimi il file scaricato e vai nella cartella Demo: troverai un file sgcOpenAPIDemo.exe, eseguilo.
Si apre una nuova form che mostra l'URL di Abstractapi.com.
Premi il pulsante successivo e seleziona il metodo Retrieve_the_location_of_an_IP_address, compila i campi Api_Key e IP Address da cercare. Se la richiesta viene elaborata con successo, sarà restituito un messaggio JSON con informazioni sull'indirizzo IP.
Qui sotto trovi il file compresso generato automaticamente dal WebService sgcOpenAPI per eseguire i test.