OpenAPI

La specifica OpenAPI (precedentemente specifica Swagger ) è uno standard per descrivere le interfacce di programmazione (API) conformi a REST . La specifica è finanziata dalla OpenAPI Initiative . L'iniziativa persegue la visione di fornire un formato di descrizione aperto e neutrale rispetto al produttore per i servizi API nell'interesse di un mondo in rete. Il progetto è supportato dalla Linux Foundation .

storia

L'Open API Specification iniziato come parte del progetto di software Swagger , un open source - Quadro per HTTP - Web Services . Nel 2016 è diventato un progetto autonomo gestito dalla OpenAPI Initiative , i cui membri includono aziende come Atlassian , Google , IBM , Microsoft , PayPal e SAP .

La versione corrente della specifica OpenAPI è la 3.1.0.

Utensili

Swagger fornisce una raccolta di strumenti open source per lo sviluppo di API conformi alla specifica OpenAPI:

  • Swagger Editor supporta la creazione della definizione API
  • Swagger Codegen genera stub server e SDK client
  • L'interfaccia utente di Swagger genera documentazione

Ci sono anche strumenti a pagamento:

  • SwaggerHub per la collaborazione
  • SwaggerHub Enterprise per le aziende, disponibile nel cloud o on- premise
  • Ispettore Swagger a scopo di test
  • APITree converte le specifiche OpenAPI 2.0 e 3.0 in documentazione API leggibile dall'uomo che può essere gestita e condivisa gratuitamente nel cloud tramite un HUB.

Esistono anche estensioni per supportare OpenAPI per vari ambienti di sviluppo.

letteratura

  • Stefan Sauter People, Michael Heiß, Christopher Köster: Ingresso in OpenAPI v3: REST sta crescendo . In: Rivista per sviluppatori . No. 1 , 2018, pag. ? ( entwickler.de [consultato il 24 febbraio 2020] Versione online gratuita ).
  • Manuel Ottlik: documento API REST secondo lo standard OpenAPI . In: c't . No. 5 , 2020, pag. 136-139 ( heise.de [consultato il 22 febbraio 2020]).

link internet

Esempi:

Evidenze individuali

  1. Specifiche OpenAPI su GitHub. Estratto il 30 dicembre 2019 .
  2. Informazioni sull'iniziativa OpenAPI. Estratto il 30 dicembre 2019 .
  3. Progetti della Linux Foundation. Estratto il 30 dicembre 2019 .
  4. Membri dell'iniziativa OpenAPI. Estratto il 30 dicembre 2019 .
  5. Rilasci della specifica OpenAPI. Estratto il 24 settembre 2020 .
  6. Strumenti open source OpenAPI. Estratto il 30 dicembre 2019 .
  7. Editor OpenAPI per Visual Studio Code. Estratto il 30 dicembre 2019 .
  8. Strumenti OpenAPI per Eclipse. Estratto il 30 dicembre 2019 .