Validator OpenAPI
Preverite dokument OpenAPI 3.0, 3.1 ali 3.2 oziroma Swagger 2.0 v YAML ali JSON ter pridobite povzetek njegovih končnih točk in shem. Validator preveri obvezna polja, predloge poti glede na parametre poti, mesta parametrov, odzivne kode, podvojene ID-je operacij in vsak lokalni $ref ter navede vsako težavo z njenim mestom.
Pogosta vprašanja
Kaj preveri orodje?
Preveri različico openapi ali swagger, info.title in info.version, ali se poti začnejo s poševnico, ali ima vsak {parameter} v poti ustrezen obvezen parameter poti in obratno, imena in mesta parametrov, statusne kode in opise odzivov, podvojene parametre, podvojene vrednosti operationId ter ali vsak lokalni $ref kaže na nekaj v dokumentu.
Ali gre za celovito preverjanje specifikacije glede na shemo JSON?
Ne. Preveri zgornja strukturna pravila, ki odkrijejo večino napak v ročno napisanih dokumentih, vendar ne preveri vsakega polja glede na uradno met shemo ali vsebine vaših shem.
Kaj prikazuje povzetek?
Specifikacijo in različico API, naslov, tabelo vseh končnih točk z metodo, potjo, operationId, povzetkom in odzivnimi kodami ter imena shem pod components.schemas oziroma definicij v Swagger 2.0.
Ali sledi zunanjim sklicem?
Ne. Sklici na druge datoteke ali URL-je se ne pridobijo in ne prikažejo. Znotraj prilepljenega dokumenta se razrešijo samo sklici, ki se začnejo z #.
Kakšna je razlika med napakami in opozorili?
Napake pomenijo kršitev pravila specifikacije, na primer manjkajoč opis odziva ali neprijavljen parameter poti. Opozorila kažejo na stvari, ki so dovoljene, vendar običajno nenamerne, na primer operacijo GET z vsebino zahteve ali dokument brez operationId.
Ali OpenAPI 3.1 spremeni obvezne elemente?
Da. V OpenAPI 3.1 in 3.2 operacija ne potrebuje več objekta responses, dokument pa lahko namesto paths vsebuje webhooks ali components. Validator uporabi ta pravila, kadar se polje openapi začne z 3.1 ali 3.2.