Università degli Studi di Napoli “Parthenope”, Facoltà di Informatica, fabionisci@gmail.com
Introduction
Quando si creano, si consultano o gestiscono API bisogna far sì che l’utente finale abbia tute le informazioni richieste e nel formato migliore. La stesura completa dei servizi spetta agli sviluppatori del server, che in questo caso potrebbero essere molti e vari. A questo punto un client, un utente generico che potrebbe aver bisogno delle informazioni e dei dati contenuti sul server deve possedere il modo di poter accedervi. Greta è una specifica implementazione di un “framework” completo per la descrizione, produzione, consumo, e visualizzare di RESTful web services, dedicato a singole e designate azioni.
Body Text
Che tu sia uno sviluppatore, un tester o un manager alcuni strumenti ti aiutano a prendere il controllo di API e servizi REST facilmente.
Siamo nella situazione in cui viene installato un semplice micro web-framework come Bottle che richiede solo i moduli della Python Standard Library ma che ci mette a disposizione un modo veloce per scrivere le nostre API consultabili da qualsiasi client fornendo la risposta in formato JSON per qualsiasi sia il metodo HTTP usato, da GET, POST o DELETE, semplicemente dichiarando il tipo di route da gestire.
La stesura completa dei servizi spetta agli sviluppatori del server, che in questo caso potrebbero essere molti e vari.
A questo punto un client, un utente generico che potrebbe aver bisogno delle informazioni e dei dati contenuti sul server deve possedere il modo di poter accedervi.
La tipica richiesta è: l’utente non è coinvolto nella programmazione dell’API quindi è totalmente imparziale e non ha necessità di conoscere come le cose sono effettivamente costruite, è semplicemente interessato a vedere se ricevo le risposte giuste seguendo la documentazione. L’approccio standard sarebbe di usare degli strumenti tecnici di interrogazione ad un server, su sistemi UNIX il più usato è “curl”. “Curl è uno strumento per trasferire dati da-a un server usando uno dei protocolli supportati, ad esempio HTTP”A. Tuttavia è legato al sistema UNIX ed è disponibile solo a riga di comando. Seppur esistano strumenti provvisti di GUI grafica non sono specifici bensì hanno molte impostazioni avanzate, non necessarie.
Greta è una specifica implementazione di un “framework” completo per la descrizione, produzione, consumo, e visualizzare di RESTful web services. L’obiettivo principale di Greta è quello di distribuire, a sistemi client e sviluppatori, la documentazione per aggiornare allo stesso ritmo del server.
L’applicazione è suddivisa in due sezioni principali il “Viewer” ed il “Composer”. Il Viewer è la sezione principale dedicata alla compilazione dei campi e alla consultazione dei servizi richiesti. Mentre il Composer è il manager delle azioni in cui specificare i parametri richiesti ed i metodi.
La guida pratica che trovere in Home Page illustrerà a tutti come documentare le api create in modo semplice, veloce e cool, grazie a GRETA!
Diciamo addio alla costruzione di complesse pagine online che tentano di spiegare come usare le nostre API, molto spesso senza riuscirci, oppure fatiscenti tentativi di copiare ed incollare la risposta del server in un form verde e nero per poi tentare vagamente di descriverne il funzionamento.
Ci sono quattro motivi motivi principali per provare GRETA
- Tutto in uno: Server, client e documentazione. Tutto insieme. GRETA può essere ospitato sia sullo stesso server che contiene le API, sia altrove essendo un modulo non dipendente dai servizi di produzione. Funziona da client web, indipendente dal sistema operativo installato, usabile da qualsiasi calcolatore fisso o mobile che disponga di un browser web.
- No Code: Greta, é in grado di fornire servizi senza accedere al codice sorgente. Tutte le informazioni sono inserite tramite la sezione “Composer”. In questo modo si possono impostare i metodi HTTP con cui effettuare le chiamate, ed in più alcuni endpoint come privati in modo da limitarne l’uso in caso di manutenzione.
- Semplicità: Compilare semplici caselle per chiamare API complesse. Nella sezione “Composer” è possibile impostare anche i parametri, il loro tipo oppure campi particolari che richiede l’azione specifica. Evitando errori di ortografia oppure parametri mancanti.
- Stile: Interfaccia a colori, chiara e concisa.
References
ADaniel Stenberg (1997). Curl Manual, curl(1).
License
Creative Commons Public License Attribuzione – Non commerciale 3.0 – http://creativecommons.org/licenses/by- nc/3.0/it/deed.it
