Validátor OpenAPI
Zkontrolujte dokument OpenAPI 3.0, 3.1 nebo 3.2 či Swagger 2.0 ve formátu YAML nebo JSON a získejte přehled jeho koncových bodů a schémat. Validátor kontroluje povinná pole, šablony cest a parametry cest, umístění parametrů, stavové kódy odpovědí, duplicitní ID operací i všechny místní odkazy $ref a každý problém uvádí spolu s jeho umístěním.
Často kladené otázky
Co validátor kontroluje?
Kontroluje verzi openapi nebo swagger, info.title a info.version, zda cesty začínají lomítkem, zda má každý {parameter} v cestě odpovídající povinný parametr cesty a naopak, názvy a umístění parametrů, stavové kódy a popisy odpovědí, duplicitní parametry, duplicitní hodnoty operationId a to, zda každý místní odkaz $ref míří na něco v dokumentu.
Jde o úplnou validaci specifikace podle schématu JSON?
Ne. Kontroluje výše uvedená strukturální pravidla, která zachytí většinu chyb v ručně psaných dokumentech, ale neověřuje každé pole vůči oficiálnímu metaschématu ani nekontroluje obsah vašich schémat.
Co přehled obsahuje?
Specifikaci a verzi API, název, tabulku všech koncových bodů s metodou, cestou, operationId, souhrnem a stavovými kódy odpovědí a názvy schémat v části components.schemas nebo definic ve Swagger 2.0.
Načítají se externí odkazy?
Ne. Odkazy na jiné soubory ani adresy URL se nenačítají ani neuvádějí. Vložený dokument řeší pouze odkazy začínající znakem #.
Jaký je rozdíl mezi chybami a varováními?
Chyby znamenají porušení pravidla specifikace, například chybějící popis odpovědi nebo nedeklarovaný parametr cesty. Varování upozorňují na věci, které jsou povolené, ale obvykle nezamýšlené, například operaci GET s tělem požadavku nebo dokument bez jakéhokoli operationId.
Mění OpenAPI 3.1 to, co je povinné?
Ano. V OpenAPI 3.1 a 3.2 operace už nepotřebuje objekt responses a dokument může místo cest obsahovat webhooks nebo components. Validátor tato pravidla uplatní, pokud pole openapi začíná hodnotou 3.1 nebo 3.2.