Preskočiť na obsah

Validátor OpenAPI

Skontrolujte dokument OpenAPI 3.0, 3.1 alebo 3.2 či Swagger 2.0 vo formáte YAML alebo JSON a získajte súhrn jeho koncových bodov a schém. Validátor kontroluje povinné polia, šablóny ciest voči parametrom ciest, umiestnenie parametrov, kódy odpovedí, duplicitné ID operácií a všetky lokálne $ref. Každý problém uvedie aj s jeho umiestnením.

Obnoviť

Často kladené otázky

Čo validátor kontroluje?

Kontroluje verziu OpenAPI alebo Swagger, info.title a info.version, či sa cesty začínajú lomkou, či má každý {parameter} v ceste zodpovedajúci povinný parameter cesty a naopak, názvy a umiestnenia parametrov, stavové kódy a opisy odpovedí, duplicitné parametre, duplicitné hodnoty operationId a to, či každý lokálny $ref odkazuje na niečo v dokumente.

Ide o úplnú validáciu špecifikácie podľa schémy JSON?

Nie. Kontroluje vyššie uvedené štrukturálne pravidlá, ktoré odhalia väčšinu chýb v dokumentoch písaných ručne, ale neoveruje každé pole podľa oficiálnej metaschémy ani nekontroluje obsah vašich schém.

Čo zobrazuje súhrn?

Špecifikáciu a verziu API, názov, tabuľku všetkých koncových bodov s metódou, cestou, operationId, súhrnom a stavovými kódmi odpovedí a názvy schém v časti components.schemas alebo definícií v Swagger 2.0.

Nasleduje sa externým odkazom?

Nie. Odkazy na iné súbory alebo URL sa nenačítavajú ani neuvádzajú. Vložený dokument spracúva iba odkazy začínajúce znakom #.

Aký je rozdiel medzi chybami a upozorneniami?

Chyby znamenajú porušenie pravidla špecifikácie, napríklad chýbajúci opis odpovede alebo nedeklarovaný parameter cesty. Upozornenia sa týkajú vecí, ktoré sú povolené, ale zvyčajne nechcené, napríklad operácie GET s telom požiadavky alebo dokumentu bez akéhokoľvek operationId.

Mení OpenAPI 3.1 požiadavky?

Áno. V OpenAPI 3.1 a 3.2 už operácia nemusí obsahovať objekt responses a dokument môže namiesto ciest obsahovať webhooks alebo components. Validátor uplatní tieto pravidlá, keď sa pole openapi začína hodnotou 3.1 alebo 3.2.

O stránke OneClick Pro

OneClick Pro je bezplatná kolekcia viac ako 150 webových nástrojov na každodennú prácu: na konverziu obrázkov a jednotiek, formátovanie a overovanie kódu, kontrolu domén a SEO, ako aj prácu s textom, dátumami a číslami. Každý nástroj funguje bez registrácie alebo predplatného a zadané údaje sa používajú iba na výpočet výsledku a nikdy sa neukladajú. Používajte ich ako rýchlu súpravu nástrojov na jednorazové úlohy alebo si uložte do záložiek nástroje, na ktoré sa spoliehate každý deň.