OpenAPI -specifikation - OpenAPI Specification

Den OpenAPI Specification , tidligere kendt som Swagger Specification , er en specifikation for maskinlæsbare grænseflade filer til at beskrive, fremstilling, forbrugende, og visualisere RESTful web services . Tidligere en del af Swagger- rammen blev det til et separat projekt i 2016, under tilsyn af OpenAPI Initiative, et open source-samarbejdsprojekt for Linux Foundation . Swagger og nogle andre værktøjer kan generere kode, dokumentation og testcases givet en grænsefladefil.

Historie

Swagger -udviklingen begyndte i begyndelsen af ​​2010 af Tony Tam, der arbejdede hos online ordbogsfirma Wordnik . Efter et møde med Kin Lane (OpenAPI -styregruppe) og Tony Tam den 12. juni 2014 henvendte Kin Lane sig til Owen Rubel, der arbejdede på en lignende tilgang og lånte sine ideer til den nye Swagger 2.0 -specifikation (som i sidste ende ville blive OpenAPI) .

I marts 2015 købte SmartBear Software open source Swagger API-specifikationen fra Reverb Technologies, Wordniks moderselskab.

I november 2015 annoncerede SmartBear, at det var ved at oprette en ny organisation kaldet OpenAPI Initiative under sponsorering af Linux Foundation . Andre stiftende medlemsvirksomheder omfattede 3scale , Apigee , Capital One , Google , IBM , Intuit , Microsoft , PayPal og Restlet. SmartBear donerede Swagger -specifikationen til den nye gruppe. RAML og API Blueprint blev også overvejet af gruppen.

Den 1. januar 2016 blev Swagger -specifikationen omdøbt til OpenAPI Specification (OAS) og blev flyttet til et nyt GitHub -depot .

I september 2016 overrakte API World -konferencen en API Infrastructure -pris til SmartBear for sit igangværende arbejde med Swagger.

I juli 2017 udgav OpenAPI Initiative version 3.0.0 af dens specifikation. MuleSoft , den vigtigste bidragyder til det alternative RESTful API Modeling Language (RAML), sluttede sig til OAS og åbnede deres API Modeling Framework-værktøj, som kan generere OAS-dokumenter fra RAML-input.

I februar 2021 udgav OpenAPI Initiative version 3.1.0. Store ændringer i OpenAPI Specification 3.1.0 inkluderer JSON Schema-ordforrådstilpasning, Nyt element på topniveau til beskrivelse af Webhooks, der er registreret og administreret uden for båndet, Understøttelse af identifikation af API-licenser ved hjælp af standard SPDX-id, og PathItems-objekt er nu valgfrit at lave det er lettere at oprette genbrugelige biblioteker med komponenter.

Udgivelsesdatoer

Version Dato Noter
3.1.0 2021-02-15 Frigivelse af OpenAPI -specifikationen 3.1.0
3.0.3 2020-02-20 Patchudgivelse af OpenAPI Specification 3.0.3
3.0.2 2018-10-08 Patch release af OpenAPI Specification 3.0.2
3.0.1 2017-12-06 Patchudgivelse af OpenAPI Specification 3.0.1
3.0.0 2017-07-26 Frigivelse af OpenAPI Specification 3.0.0
2.0 2014-09-08 Udgivelse af Swagger 2.0
1.2 2014-03-14 Indledende frigivelse af det formelle dokument
1.1 2012-08-22 Udgivelse af Swagger 1.1
1.0 2011-08-10 Første udgivelse af Swagger Specification

Anvendelse

Applikationer implementeret baseret på OpenAPI -grænsefladefiler kan automatisk generere dokumentation af metoder, parametre og modeller. Dette hjælper med at holde dokumentationen , klientbibliotekerne og kildekoden synkroniseret.

Funktioner

OpenAPI-specifikationen er sprogagnostisk. Med OpenAPIs erklærende ressourcespecifikation kan klienter forstå og forbruge tjenester uden kendskab til serverimplementering eller adgang til serverkoden.

Værktøjer, der fungerer med OpenAPI

OpenAPI Initiative fører en liste over implementeringer til version 3.0 af specifikationen. SmartBear mærker stadig sine OpenAPI -værktøjer med Swagger moniker. Swagger UI-ramme gør det muligt for både udviklere og ikke-udviklere at interagere med API'en i en sandkasse-brugergrænseflade, der giver indsigt i, hvordan API'en reagerer på parametre og muligheder. Swagger kan håndtere både JSON og XML .

Swagger Codegen indeholder en skabelondrevet motor til at generere dokumentation, API-klienter og serverstubbe på forskellige sprog ved at analysere OpenAPI-definitionen. I juli 2018, William Cheng, den øverste bidragyder til Swagger Codegen, og mere end 40 andre bidragydere til Swagger Codegen kløvet koden i et projekt ved navn OpenAPI Generator under OpenAPI Værktøj organisation.

Årlig konference

OpenAPI Initiative sponsorerer en API Specification Conference (ASC) årligt. Arrangementet har sit udspring i API Strategy and Practice Conference (APIStrat), der løb i mange år og blev en del af OpenAPI Initiative i 2016.

Se også

Referencer

Bibliografi

  • Haupt, F .; Karastoyanova, D .; Leymann, F .; Schroth, B. (2014). En model-drevet tilgang til REST-kompatible tjenester . ICWS 2014. 2014 IEEE International Conference on Web Services . s. 129–136. doi : 10.1109/ICWS.2014.30 . ISBN 978-1-4799-5054-6.
  • Pautasso, Cesare (2021). Smukke API'er . LeanPub. s. 100.

eksterne links