Specifikace OpenAPI
Specifikace OpenAPI (původně známá jako Swagger Specification ) je specifikace pro strojově čitelné soubory rozhraní pro popis, produkci, používání a zobrazování webových služeb RESTful . [1] Sada nástrojů může generovat kód, dokumentaci a testovací případy s daným souborem rozhraní.
Použití
Aplikace implementované na základě souborů rozhraní OpenAPI mohou automaticky generovat dokumentaci metod, parametrů a šablon. To pomáhá synchronizovat dokumentaci, klientské knihovny a zdrojový kód.
Historie
Jak specifikace, tak implementace rámce začaly jako iniciativa Wordniku. Swagger byl vyvinut pomocí Wordniku při vývoji Wordnik Developer a základního API. Vývoj swaggeru začal na začátku roku 2010. [2]
V listopadu 2015 SmartBear, společnost, která podporovala Swagger, oznámila, že pomáhá vytvořit novou organizaci, sponzorovanou Linux Foundation , nazvanou Open API Initiative. Zakládajícími partnery je řada společností, včetně Google , IBM a Microsoft . [3] [4] Swagger daroval specifikaci Swagger nové skupině. Skupina také zvažuje RAML a API Blueprint. [5] [6]
1. ledna 2016 byla specifikace Swagger přejmenována na OpenAPI Spec a přesunuta do nového úložiště na GitHubu.
Funkce
Specifikace OpenAPI nevyžaduje specifický jazyk. Je také rozšiřitelný o nové technologie a protokoly mimo HTTP. [2]
Díky deklarativní specifikaci zdrojů mohou klienti chápat a využívat služby, aniž by znali implementaci serveru nebo přistupovali k kódu serveru. [2]
Rámec uživatelského rozhraní Swagger umožňuje vývojářům i nevývojářům interakci s rozhraním API v karanténě uživatelského rozhraní, která nabízí jasný přehled o tom, jak rozhraní API reaguje na parametry a možnosti. Swagger může používat JSON i YAML. [2]
Poznámky
- ^ Linux Foundation chce rozšířit Swagger v propojených budovách | Business Cloud News , na businesscloudnews.com . Staženo 22. dubna 2016 .
- ^ a b c d swagger-api / swagger-spec , na GitHubu . Načteno 1. prosince 2015 .
- ^ SmartBear, Linux Foundation spouští Open API Initiative to Evolve Swagger , ProgrammableWeb , 10. listopadu 2015. Staženo 21. dubna 2016 .
- ^ Nový projekt spolupráce na rozšíření specifikace Swagger pro vytváření propojených aplikací a služeb na linuxfoundation.org . Získáno 22. dubna 2016 (z originálu archivováno 27. dubna 2016) .
- ^ Yves de Montcheuil, V roce 2016 vykrystalizuje potřeba metajazyka API na InfoWorldu . Staženo 25. dubna 2016 .
- ^ Amazon API Gateway nyní podporuje Swagger Definition Import , na InfoQ . Staženo 25. dubna 2016 .
Bibliografie
- F. Haupt, D. Karastoyanova, F. Leymann a B. Schroth, A Model-Driven Approach for REST Compliant Services , in ICWS 2014 , 2014 IEEE International Conference on Web Services , 2014, pp. 129–136, DOI : 10.1109 / ICWS.2014.30 , ISBN 978-1-4799-5054-6 .
