Specifikace OpenAPI - OpenAPI Specification

The Specifikace OpenAPI, původně známý jako Specifikace Swagger, je specifikace strojově čitelných souborů rozhraní pro popis, produkci, spotřebu a vizualizaci Klidný webové služby.[1] Původně součást Naparování v roce 2016 se stal samostatným projektem, na který dohlíží iniciativa OpenAPI, projekt spolupráce open-source Linux Foundation.[2] Swagger a některé další nástroje mohou generovat kód, dokumentaci a testovací případy dané souborem rozhraní.

Dějiny

Naparování vývoj začal počátkem roku 2010 Tony Tam, který pracoval ve společnosti pro online slovník Wordnik.[3] V březnu 2015 Software SmartBear získal specifikaci Swagger API open-source od Reverb Technologies, mateřské společnosti Wordnik.[4]

V listopadu 2015 společnost SmartBear oznámila, že vytváří novou organizaci nazvanou OpenAPI Initiative pod záštitou Linux Foundation. Včetně dalších zakládajících členských společností 3 Měřítko, Apigee, Hlavní město, Google, IBM, Intuice, Microsoft, PayPal a Restlet.[5][6][7] SmartBear daroval specifikaci Swagger nové skupině. RAML a API Blueprint byly rovněž zvažovány skupinou.[8][9]

1. ledna 2016 byla specifikace Swagger přejmenována na Specifikace OpenAPI (OAS) a byla přesunuta do nové GitHub úložiště.[10]

V září 2016 předala konference API World ocenění API Infrastructure společnosti SmartBear za pokračující práci na Swagger.[11]

V červenci 2017 vydala iniciativa OpenAPI verzi 3.0.0 své specifikace.[12] MuleSoft, hlavní přispěvatel do alternativy RESTful API Modeling Language (RAML), připojil se k OAS a otevřeně získal svůj nástroj API Modeling Framework, který může generovat dokumenty OAS ze vstupu RAML.[13]

Datum vydání

VerzedatumPoznámky[14]
3.0.32020-02-20Vydání opravy specifikace OpenAPI 3.0.3
3.0.22018-10-08Vydání opravy specifikace OpenAPI 3.0.2
3.0.12017-12-06Vydání opravy specifikace OpenAPI 3.0.1
3.0.02017-07-26Vydání specifikace OpenAPI 3.0.0
2.02014-09-08Vydání Swagger 2.0
1.22014-03-14První vydání formálního dokumentu
1.12012-08-22Release of Swagger 1.1
1.02011-08-10První vydání specifikace Swagger

Používání

Aplikace implementované na základě souborů rozhraní OpenAPI mohou automaticky generovat dokumentaci metod, parametrů a modelů. To pomáhá udržet dokumentace, klientské knihovny a synchronizovaný zdrojový kód.[15]

Funkce

Specifikace OpenAPI je jazykově agnostická. S OpenAPI deklarativní specifikace zdroje, klienti mohou porozumět a využívat služby bez znalosti implementace serveru nebo přístupu k kódu serveru.[15]

Nástroje, které fungují s OpenAPI

Iniciativa OpenAPI udržuje a seznam implementací pro verzi 3.0 specifikace. SmartBear stále označuje své nástroje OpenAPI pod přezdívkou Swagger. Rámec uživatelského rozhraní Swagger umožňuje vývojářům i vývojářům interakci s API v uživatelském rozhraní karantény, které poskytuje přehled o tom, jak API reaguje na parametry a možnosti. Swagger zvládne obojí JSON a XML.[15]

Swagger Codegen obsahuje motor založený na šabloně, který generuje dokumentaci, klienty API a útržky serverů v různých jazycích analýzou definice OpenAPI. V červenci 2018 William Cheng, hlavní přispěvatel do Swagger Codegen, a více než 40 dalších přispěvatelů do Swagger Codegen rozeklaný kód do projektu s názvem Generátor OpenAPI v rámci organizace OpenAPI Tools.[16] [17]

Viz také

Reference

  1. ^ „Linux Foundation chce rozšířit Swagger v připojených budovách | Business Cloud News“. Citováno 22. dubna 2016.
  2. ^ „Charta iniciativy OpenAPI“. Iniciativa OpenAPI. Citováno 12. listopadu 2019.
  3. ^ „Tvůrce Swagger se připojuje k SmartBear“. Citováno 6. srpna 2019.
  4. ^ „SmartBear převzal sponzorství Open Source projektu Swagger API“. SmartBear. Citováno 25. března 2015.
  5. ^ „FAQ“. Iniciativa OpenAPI. Citováno 12. listopadu 2019.
  6. ^ „SmartBear, Linux Foundation zahajuje iniciativu Open API Initiative to Evolve Swagger“. Programovatelný web. 10. listopadu 2015. Citováno 21. dubna 2016.
  7. ^ „Nový projekt spolupráce, který rozšíří specifikace Swagger pro vytváření propojených aplikací a služeb“. www.linuxfoundation.org. Archivovány od originál dne 27. dubna 2016. Citováno 22. dubna 2016.
  8. ^ Montcheuil, Yves de. „V roce 2016 se krystalizuje potřeba metajazyka API.“. InfoWorld. Citováno 25. dubna 2016.
  9. ^ „Amazon API Gateway nyní podporuje import definic Swagger“. InfoQ. Citováno 25. dubna 2016.
  10. ^ Iniciativa OpenAPI. "Specifikace OpenAPI". GitHub. Citováno 12. listopadu 2019.
  11. ^ „Swagger získává cenu API API 2016 za infrastrukturu API“. Swagger Blog. Citováno 27. července 2018.
  12. ^ „OAI ohlašuje specifikaci OpenAPI 3.0.0“. OpenAPI. Citováno 19. dubna 2018.
  13. ^ „Prostor HTTP API se konsoliduje kolem OAS“. InfoQ. Citováno 14. května 2017.
  14. ^ [b „Specifikace OpenAPI verze 3.0.4“] Šek | url = hodnota (Pomoc). Citováno 23. dubna 2020.
  15. ^ A b C „swagger-api / swagger-spec“. GitHub. Citováno 1. prosince 2015.
  16. ^ „Swagger Codegen je nyní generátor OpenAPI“. Citováno 6. srpna 2019.
  17. ^ „Swagger Codegen Fork: Q&A“. Citováno 6. srpna 2019.

Bibliografie

  • Haupt, F .; Karastoyanova, D .; Leymann, F .; Schroth, B. (2014). Přístup zaměřený na model pro služby vyhovující REST. ICWS 2014. Mezinárodní konference IEEE 2014 o webových službách. str. 129–136. doi:10.1109 / ICWS.2014.30. ISBN  978-1-4799-5054-6.

externí odkazy