Specifiche OpenAPI: differenze tra le versioni

Versione delle 21:59, 23 ott 2024

Versione attuale delle 00:16, 16 mar 2025

(8 versioni intermedie di 6 utenti non mostrate)

Riga 1:

{{Correggere|informatica|marzo 2024|Traduzione frettolosa}}{{Aggiornare|anno=2016|argomento=informatica}}

La '''Specifica OpenAPI''' (originariamente nota come '''Specifica Swagger''') è una specifica per file di interfaccia leggibili dalle macchine, utilizzata per descrivere, produrre, consumare e visualizzare [[Web service|servizi web]] [[Representational State Transfer|RESTful]].<ref>{{Cita web|url=http://www.businesscloudnews.com/2015/11/06/linux-foundation-wants-to-extend-swagger-in-connected-buildings/|titolo=Linux Foundation wants to extend Swagger in connected buildings {{!}} Business Cloud News|accesso=22 aprile 2016|dataarchivio=20 luglio 2018|urlarchivio=https://web.archive.org/web/20180720165819/http://www.businesscloudnews.com/2015/11/06/linux-foundation-wants-to-extend-swagger-in-connected-buildings/|urlmorto=sì}}</ref> Un documento OpenAPI rappresenta una descrizione formale di un'[[Application programming interface|API]], che può essere utilizzata da diversi strumenti per generare codice, documentazione, ''[[test case]]'' e altro ancora.

== Uso ==

Le applicazioni implementate, basandosi su file di interfaccia OpenAPI, possono automaticamente generare automaticamente la documentazione didei metodi, dei parametri e dei modelli. Questo aiuta a sincronizzare la documentazione, le librerie [[client]] e il [[codice sorgente]].

== Storia ==

Sia la specifica siache l'implementazione di un [[framework]] sono partitenate come iniziative dadi Wordnik. Swagger è stato sviluppato dall'uso di Wordnik durante lo sviluppo di Wordnik Developer e ladella sottostante API. Lo sviluppo di Swagger è partito ainiziato all'inizio del 2010.<ref name=git>{{Cita web|titolo= swagger-api/swagger-spec|url= https://github.com/swagger-api/swagger-spec/wiki|sito= GitHub|accesso= 1º dicembre 2015}}</ref>

Nel novembre 2015, SmartBear, la società che ha sostenuto Swagger, ha annunciato che stava aiutandocontribuendo aalla crearecreazione di una nuova organizzazione, sotto la sponsorizzazione della [[Linux Foundation]], chiamata OpenAPI Initiative. Una serie di società, incluse [[Google]], [[IBM]] e [[Microsoft]], sono soci fondatori.<ref>{{Cita news|url=http://www.programmableweb.com/news/%E2%80%8Bsmartbear-linux-foundation-launch-open-api-initiative-to-evolve-swagger/2015/11/10|titolo=SmartBear, Linux Foundation launch Open API Initiative to Evolve Swagger|cognome=|nome=|data=10 novembre 2015|pubblicazione=ProgrammableWeb|accesso=21 aprile 2016|dataarchivio=9 novembre 2016|urlarchivio=https://web.archive.org/web/20161109214454/http://www.programmableweb.com/news/%E2%80%8Bsmartbear-linux-foundation-launch-open-api-initiative-to-evolve-swagger/2015/11/10|urlmorto=sì}}</ref><ref>{{Cita web|url=https://www.linuxfoundation.org/news-media/announcements/2015/11/new-collaborative-project-extend-swagger-specification-building|titolo=New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services|accesso=22 aprile 2016|urlmorto=sì|urlarchivio=https://web.archive.org/web/20160427104213/http://www.linuxfoundation.org/news-media/announcements/2015/11/new-collaborative-project-extend-swagger-specification-building|dataarchivio=27 aprile 2016}}</ref> Nello stesso anno, Swagger ha donato la specifica Swagger 2.0 al nuovo gruppo OpenAPI Initiative.<ref>{{Cita web|url=https://spec.openapis.org/oas/v3.1.0#appendix-a-revision-history|titolo=OpenAPI Specification v3.1.0 {{!}} Introduction, Definitions, & More|sito=spec.openapis.org|accesso=2024-03-25}}</ref>. Anche RAML e API Blueprint sono in esame da parte del gruppo.<ref>{{Cita web|url=http://www.infoworld.com/article/3014506/apis/in-2016-the-need-for-an-api-meta-language-will-crystallize.html|titolo=In 2016, the need for an API meta-language will crystallize|cognome=Montcheuil|nome=Yves de|sito=InfoWorld|accesso=25 aprile 2016}}</ref><ref>{{Cita web|url=http://www.infoq.com/news/2016/04/Amazon-API-Gateway-Swagger|titolo=Amazon API Gateway Now Supports Swagger Definition Import|sito=InfoQ|accesso=25 aprile 2016}}</ref>

Il 1º gennaio 2016, la specifica Swagger è stata rinominata OpenAPI, ed è stata spostata in un nuovo [[repository]] su [[GitHub]].

Il 26 Luglioluglio 2017, l'OpenAPI Initiative ha rilasciato la versione 3.0.0 della specifica.<ref>{{Cita web|url=https://www.openapis.org/blog/2017/07/26/the-oai-announces-the-openapi-specification-3-0-0|titolo=The OAI Announces the OpenAPI Specification 3.0.0|autore=OpenAPI Initiative|sito=OpenAPI Initiative|data=2017-07-26|lingua=en-US|accesso=2024-10-13}}</ref> Tra le novità possiamo notare una semplificazione della struttura, introducendo unacon maggiore riutilizzabilità dei componenti; un miglioramento delle definizioni di sicurezza, tra cuiinclusa la rinominazione dei flussi [[OAuth]] 2 per corrispondere alla specifica Oauth2OAuth2; l'aggiunta delle [[callback]] e dei link.<ref>{{Cita web|url=https://swagger.io/blog/news/whats-new-in-openapi-3-0/|titolo=What is OpenAPI 3.0? {{!}} Swagger Blog|sito=SmartBear.com|accesso=2024-10-13}}</ref>

Il 15 febbraio 2021, l'OpenAPI Initiative ha rilasciato la versione 3.1.0 della specifica.<ref>{{Cita web|url=https://www.linux.com/news/openapi-specification-3-1-0-available-now/|titolo=OpenAPI Specification 3.1.0 Available Now|autore=Linux com Editorial Staff|sito=Linux.com|data=2021-04-26|lingua=en-US|accesso=2024-10-13}}</ref>. Le principali modifiche includono l'allineamento con i vocabolari dello schema [[JavaScript Object Notation|JSON]], l'introduzione di nuovi elementi di primo livello per descrivere i [[webhook]] che sono registrati e gestiti fuori banda, il supporto per identificare le licenze [[Application programming interface|API]] utilizzando l'identificatore standard [[Software Package Data Exchange|SPDX]], la possibilità di includere descrizioni accanto all'uso dei riferimenti di schema e una modifica perche rendererende l'oggetto PathItems opzionale, semplificando così la creazione di librerie riutilizzabili di componenti.<ref>{{Cita web|url=https://nordicapis.com/whats-new-in-openapi-3-1-0/|titolo=What’s New in OpenAPI 3.1.0? {{!}} Nordic APIs {{!}}|autore=Tyler Charboneau|sito=Nordic APIs|data=2021-04-07|lingua=en-US|accesso=2024-10-13}}</ref><ref>{{Cita web|url=https://www.openapis.org/blog/2021/02/18/openapi-specification-3-1-released|titolo=OpenAPI Specification 3.1.0 Released|autore=OpenAPI Initiative|sito=OpenAPI Initiative|data=2021-02-18|lingua=en-US|accesso=2024-10-13}}</ref><ref>{{Cita web|url=https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0|titolo=Migrating from OpenAPI 3.0 to 3.1.0|autore=OpenAPI Initiative|sito=OpenAPI Initiative|data=2021-02-16|lingua=en-US|accesso=2024-10-13}}</ref>

== Caratteristiche ==

La Specificaspecifica OpenAPI non richiede un [[linguaggio di programmazione]] specifico. Inoltre, è estendibile super l'uso con nuove tecnologie e protocolli. oltreGli lstrumenti OpenAPI sono generalmente compatibili con le specifiche RESTful e descrivono come un'HTTPAPI è organizzata e come interagisce con gli utenti, facendo uso di strumenti come Swagger UI, Swagger Codegen, Swagger Hub e Swagger Editor.<ref name=gitL'architettura di base della specifica si concentra su tre componenti />principali:

* Descrizione di un'API

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]].<ref>{{Cita web|url=https://spec.openapis.org/oas/v3.1.0|titolo=OpenAPI Specification v3.1.0 {{!}} Introduction, Definitions, & More|sito=spec.openapis.org|accesso=2024-03-25}}</ref>

* Definizione dei parametri di un'API

* Documentazione dei metodi di un'API

== Versioni ==

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]].<ref name=git />

=== Swagger ===

* 1.0 (2011)

* 2.0 (2014)

=== OpenAPI ===

* 3.0.0 (2017)

* 3.1.0 (2021)

==Note==

Line 28 ⟶ 38:

==Bibliografia==

*{{Cita conferenza| doi = 10.1109/ICWS.2014.30|titolo= A Model-Driven Approach for REST Compliant Services|collana= 2014 IEEE International Conference on Web Services|conferenza= [[International Conference on Web Services|ICWS]] 2014|pp= 129–136129-136|anno= 2014|cognome1= Haupt |nome1= F. |cognome2= Karastoyanova |nome2= D. |cognome3= Leymann |nome3= F. |cognome4= Schroth |nome4= B. | isbn = 978-1-4799-5054-6}}

==Voci correlate==

* [[Application programming interface]]

* [[Representational State Transfer]]

* [[RESTful]]

* [[Linux Foundation]]

* [[GitHub]]

==Collegamenti esterni==

* {{Collegamenti esterni}}

*[https://openapis.org/ Open API Initiative (OAI) website]

*[http://swagger.io Swagger website]

*[https://github.com/OAI/OpenAPI-Specification OpenAPI Specification on GitHub]

{{portale|informatica}}

[[Categoria:Architettura del software]]