[VSA | Cvičenie] 9 - OpenAPI 3

Zhrnutie prednášky

Cvičenie nadväzuje na prednášku o REST-ových službách a zameriava sa na štandard OpenAPI 3 (nástupca Swaggeru) používaný na dokumentáciu REST API tak, aby bola čitateľná pre ľudí aj spracovateľná automatizovane. Na existujúcom projekte s resourcami Publisher, Game a Developer sa demonštruje ručné písanie špecifikácie v Swagger Editore vo formáte YAML. Postupne sa definujú základné časti dokumentu – info (title, version), servers (URL beh aplikácie) a paths s jednotlivými endpointmi (napr. GET /publisher) vrátane HTTP metód, summary a responses s príslušnými stavovými kódmi (200, 400, 500). Spomína sa aj možnosť generovania špecifikácie priamo z kódu pomocou Maven pluginov a možnosť generovať zo špecifikácie server aj klientsky kód v rôznych technológiách (Java, Spring, Node.js, TypeScript a i.).

• - OpenAPI 3 je štandard (nástupca Swaggeru) na popis REST API pre ľudí aj stroje
• - Dokumentácia sa píše vo formáte YAML (alebo JSON) v nástroji Swagger Editor
• - Špecifikácia obsahuje povinné sekcie info, servers a paths
• - Pre každú cestu (path) sa definujú HTTP metódy (GET, POST) s summary a responses
• - Responses sa definujú podľa HTTP stavových kódov (napr. 200, 400, 500)
• - Zo špecifikácie je možné automaticky generovať server aj klientsky kód v rôznych jazykoch/frameworkoch
• - Existuje aj možnosť generovať OpenAPI špecifikáciu priamo z existujúceho kódu pomocou Maven pluginov

Zhrnutie pripravené s pomocou AI z prepisu videa.