Treci la conținut

Validator OpenAPI

Verificați un document OpenAPI 3.0, 3.1 sau 3.2 ori Swagger 2.0 în YAML sau JSON și obțineți un rezumat al punctelor terminale și schemelor sale. Validatorul verifică câmpurile obligatorii, șabloanele de cale în raport cu parametrii de cale, locațiile parametrilor, codurile de răspuns, ID-urile de operație duplicate și fiecare $ref local, apoi listează fiecare problemă împreună cu locația sa.

Resetează

Întrebări frecvente

Ce verifică validatorul?

Verifică versiunea openapi sau swagger, info.title și info.version, dacă căile încep cu o bară oblică, dacă fiecare {parameter} dintr-o cale are un parametru de cale obligatoriu corespunzător și invers, numele și locațiile parametrilor, codurile de stare și descrierile răspunsurilor, parametrii duplicați, valorile operationId duplicate și dacă fiecare $ref local indică spre ceva din document.

Este aceasta o validare completă a specificației în raport cu JSON Schema?

Nu. Verifică regulile structurale de mai sus, care detectează majoritatea greșelilor din documentele redactate manual, dar nu validează fiecare câmp în raport cu metaschema oficială și nici nu verifică conținutul schemelor dumneavoastră.

Ce arată rezumatul?

Versiunea specificației și a API, titlul, un tabel cu fiecare punct terminal, metoda, calea, operationId, rezumatul și codurile de răspuns ale acestuia, precum și numele schemelor din components.schemas sau din definitions în Swagger 2.0.

Sunt urmate referințele externe?

Nu. Referințele către alte fișiere sau URL-uri nu sunt preluate și nici raportate. Sunt rezolvate în documentul lipit doar referințele care încep cu #.

Care este diferența dintre erori și avertismente?

Erorile încalcă o regulă a specificației, de exemplu o descriere de răspuns lipsă sau un parametru de cale nedeclarat. Avertismentele indică lucruri permise, dar de obicei neintenționate, cum ar fi o operație GET cu corp de cerere sau un document fără niciun operationId.

OpenAPI 3.1 schimbă cerințele?

Da. În OpenAPI 3.1 și 3.2, o operație nu mai are nevoie de un obiect responses, iar un document poate conține webhooks sau components în loc de paths. Validatorul aplică aceste reguli când câmpul openapi începe cu 3.1 sau 3.2.

Despre OneClick Pro

OneClick Pro este o colecție gratuită de peste 150 de instrumente web pentru activitățile de zi cu zi: conversia imaginilor și unităților, formatarea și validarea codului, verificarea domeniilor și a SEO, precum și lucrul cu text, date și numere. Fiecare instrument funcționează fără înregistrare sau abonament, iar ceea ce introduceți este folosit doar pentru a calcula rezultatul și nu este stocat niciodată. Folosiți colecția ca trusă de instrumente rapidă pentru sarcini ocazionale sau salvați în marcaje instrumentele pe care le utilizați în fiecare zi.