Čo je OpenAPI?
OpenAPI (predtým Swagger Specification) je štandard na popis REST API v strojovo čitateľnom formáte (YAML alebo JSON). Spravuje ho OpenAPI Initiative pod záštitou Linux Foundation. Umožňuje automatické generovanie dokumentácie, klientských knižníc a testov.
Definícia OpenAPI
Čo je OpenAPI
OpenAPI Specification (predtým známa ako Swagger Specification) je štandard na opis webových API v strojovo čitateľnom formáte. Vývoj začal v roku 2010, keď Tony Tam vytvoril Swagger pri práci v online slovníku Wordnik. V novembri 2015 spoločnosť SmartBear Software darovala špecifikáciu novej organizácii OpenAPI Initiative pod Linux Foundation.
Medzi zakladajúcich členov patria Google, IBM, Microsoft, PayPal a Capital One.
Čo OpenAPI popisuje
- Endpointy — dostupné URL adresy a HTTP metódy (GET, POST, PUT, DELETE)
- Parametre — vstupné parametre (query, path, header, cookie)
- Schémy dát — štruktúra požiadaviek a odpovedí (JSON Schema)
- Autentifikácia — podporované metódy (API kľúč, OAuth 2.0, Bearer token)
- Chybové kódy — možné stavové kódy a ich význam
Z jedného OpenAPI súboru (YAML/JSON) sa dá automaticky vygenerovať interaktívna dokumentácia (Swagger UI), klientské SDK pre rôzne jazyky, serverové stuby a testy. Aktuálna verzia je OpenAPI 3.2.0 (september 2025).
Praktický príklad
Príklad: Vytvárate API pre rezervačný systém reštaurácie.
Napíšete OpenAPI špecifikáciu v YAML súbore, kde definujete endpoint /api/rezervacie, jeho parametre (dátum, čas, počet osôb) a štruktúru odpovede. Z tohto jedného súboru automaticky vygenerujete dokumentáciu pre vývojárov, Python SDK pre mobilnú appku a TypeScript klienta pre web — bez ručného písania kódu.
Často kladené otázky
Čo je OpenAPI a aký je rozdiel od Swagger?
OpenAPI je štandard na popis REST API. Swagger bolo pôvodné meno špecifikácie — v roku 2015 bola premenovaná na OpenAPI. Dnes „Swagger" označuje nástroje od SmartBear (Swagger UI, Swagger Editor), zatiaľ čo „OpenAPI" je samotná špecifikácia.
Prečo by som mal používať OpenAPI?
OpenAPI umožňuje automatické generovanie dokumentácie, klientských knižníc, testov a serverového kódu z jedného súboru. Zjednodušuje spoluprácu medzi frontend a backend tímami a zabezpečuje konzistentnosť API.
V akom formáte sa píše OpenAPI špecifikácia?
OpenAPI špecifikácia sa píše vo formáte YAML alebo JSON. YAML je populárnejší pre svoju čitateľnosť. Súbor typicky obsahuje informácie o endpointoch, parametroch, schémach dát a autentifikácii.
Súvisiace pojmy
Potrebujete pomôcť s webom?
Napíšte mi a poradím vám s vaším projektom. Prvá konzultácia je zadarmo a nezáväzná.