La Specifica OpenAPI (originariamente nota come Specifica Swagger) è una specifica per file di interfaccia leggibili dalle macchine per descrivere, produrre, consumare e visualizzare servizi web RESTful.[1] Un documento OpenAPI rappresenta una descrizione formale di un'API che può essere utilizzata da diversi strumenti per generare codice, documentazione, test case e altro ancora.
Uso
[modifica | modifica wikitesto]Le applicazioni implementate basandosi su file di interfaccia OpenAPI possono automaticamente generare la documentazione di metodi, parametri e modelli. Questo aiuta a sincronizzare la documentazione, le librerie client e il codice sorgente.
Storia
[modifica | modifica wikitesto]Sia la specifica sia l'implementazione di un framework sono partite come iniziative da Wordnik. Swagger è stato sviluppato dall'uso di Wordnik durante lo sviluppo di Wordnik Developer e la sottostante API. Lo sviluppo di Swagger è partito a inizio 2010.[2]
Nel novembre 2015 SmartBear, la società che ha sostenuto Swagger, ha annunciato che stava aiutando a creare una nuova organizzazione, sotto la sponsorizzazione della Linux Foundation, chiamata OpenAPI Initiative. Una serie di società, incluse Google, IBM e Microsoft sono soci fondatori.[3][4] Nello stesso anno Swagger ha donato la specifica Swagger 2.0 al nuovo gruppo OpenAPI Initiative[5]. Anche RAML e API Blueprint sono in esame da parte del gruppo.[6][7]
Il 1 gennaio 2016 la specifica Swagger è stata rinominata la Specifica OpenAPI, ed è stata spostata in una nuova repository su GitHub.
Caratteristiche
[modifica | modifica wikitesto]La Specifica OpenAPI non richiede un linguaggio specifico. Inoltre è estendibile su nuove tecnologie e protocolli oltre l'HTTP.[2]
Questo standard viene utilizzato per descrivere un'interfaccia in modo agnostico rispetto al linguaggio di programmazione utilizzato. In tal modo essa consente alle macchine e agli esseri umani di comprendere le caratteristiche di un servizio anche senza avere l'accesso al codice sorgente.[8]
Il framework UI Swagger permette sia a sviluppatori sia a non-sviluppatori di interagire con la API in una sandbox UI che offre una chiara intuizione di come la API risponde ai parametri e alle opzioni. Swagger può utilizzare sia JSON sia YAML.[2]
Note
[modifica | modifica wikitesto]- ^ Linux Foundation wants to extend Swagger in connected buildings | Business Cloud News, su businesscloudnews.com. URL consultato il 22 aprile 2016 (archiviato dall'url originale il 20 luglio 2018).
- ^ a b c swagger-api/swagger-spec, su GitHub. URL consultato il 1º dicembre 2015.
- ^ SmartBear, Linux Foundation launch Open API Initiative to Evolve Swagger, in ProgrammableWeb, 10 novembre 2015. URL consultato il 21 aprile 2016 (archiviato dall'url originale il 9 novembre 2016).
- ^ New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services, su linuxfoundation.org. URL consultato il 22 aprile 2016 (archiviato dall'url originale il 27 aprile 2016).
- ^ OpenAPI Specification v3.1.0 | Introduction, Definitions, & More, su spec.openapis.org. URL consultato il 25 marzo 2024.
- ^ Yves de Montcheuil, In 2016, the need for an API meta-language will crystallize, su InfoWorld. URL consultato il 25 aprile 2016.
- ^ Amazon API Gateway Now Supports Swagger Definition Import, su InfoQ. URL consultato il 25 aprile 2016.
- ^ OpenAPI Specification v3.1.0 | Introduction, Definitions, & More, su spec.openapis.org. URL consultato il 25 marzo 2024.
Bibliografia
[modifica | modifica wikitesto]- F. Haupt, D. Karastoyanova, F. Leymann e B. Schroth, A Model-Driven Approach for REST Compliant Services, ICWS 2014, collana 2014 IEEE International Conference on Web Services, 2014, pp. 129–136, DOI:10.1109/ICWS.2014.30, ISBN 978-1-4799-5054-6.