Čo je Swagger?
Swagger je sada open-source nástrojov na navrhovanie, vytváranie, dokumentovanie a testovanie REST API. Pôvodne to bolo aj meno špecifikácie, ktorá bola v roku 2015 premenovaná na OpenAPI. Swagger nástroje dnes vyvíja spoločnosť SmartBear Software.
Definícia Swagger
Čo je Swagger
Swagger je sada open-source nástrojov na prácu s REST API, ktorú vyvíja spoločnosť SmartBear Software. Vývoj začal v roku 2011 a pôvodne zahŕňal aj samotnú špecifikáciu na popis API. V roku 2015 bola špecifikácia darovaná OpenAPI Initiative a premenovaná na OpenAPI Specification. Meno „Swagger" zostalo pre nástroje.
Hlavné Swagger nástroje
- Swagger Editor — webový editor na písanie OpenAPI špecifikácií s okamžitým náhľadom a validáciou v reálnom čase
- Swagger UI — automaticky generuje interaktívnu HTML dokumentáciu z OpenAPI súboru, kde si vývojári môžu priamo testovať endpointy
- Swagger Codegen — generuje klientské SDK, serverové stuby a API dokumentáciu vo viac ako 40 programovacích jazykoch
- SwaggerHub — komerčná platforma na kolaboratívny dizajn a správu API
Swagger UI je de facto štandard — keď otvoríte dokumentáciu API a vidíte interaktívne rozhranie so zelenými (GET), modrými (POST) a červenými (DELETE) blokmi, s najväčšou pravdepodobnosťou sa pozeráte na Swagger UI. Používajú ho spoločnosti od startupov po korporácie vrátane Microsoftu, IBM a Amazon.
Praktický príklad
Príklad: Váš backendový tím vytvoril REST API a potrebuje zdokumentovať endpointy pre frontendových vývojárov.
Napíšete OpenAPI špecifikáciu v Swagger Editore, kde vidíte náhľad v reálnom čase. Potom spustíte Swagger UI, ktoré z tej istej špecifikácie vygeneruje krásnu interaktívnu dokumentáciu. Frontendáci si priamo v prehliadači môžu vyskúšať každý endpoint, vidieť požadované parametre a štruktúru odpovede — bez čítania kódu.
Často kladené otázky
Čo je Swagger a aký je rozdiel od OpenAPI?
Swagger je sada nástrojov (Editor, UI, Codegen) na prácu s API od SmartBear Software. OpenAPI je samotná špecifikácia na popis API. Pôvodne boli jedno a to isté — v roku 2015 sa špecifikácia oddelila a premenovala na OpenAPI.
Je Swagger zadarmo?
Základné nástroje (Swagger Editor, Swagger UI, Swagger Codegen) sú open-source a zadarmo. SwaggerHub je komerčný produkt s plateným plánom pre tímy, ktoré potrebujú kolaboratívny dizajn a správu API.
Ako začať so Swagger?
Najjednoduchšie je otvoriť editor.swagger.io v prehliadači, napísať OpenAPI špecifikáciu v YAML formáte a okamžite vidieť vygenerovanú dokumentáciu. Pre existujúce API môžete použiť knižnice, ktoré vygenerujú špecifikáciu z kódu.
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á.