Pāriet uz saturu

OpenAPI validators

Pārbaudiet OpenAPI 3.0, 3.1 vai 3.2 vai Swagger 2.0 dokumentu formātā YAML vai JSON un saņemiet tā galapunktu un shēmu kopsavilkumu. Validators pārbauda obligātos laukus, ceļu veidnes un ceļa parametrus, parametru atrašanās vietas, atbilžu kodus, dublētus operāciju ID un visas lokālās $ref atsauces, kā arī uzskaita katru problēmu un tās atrašanās vietu.

Atiestatīt

Bieži uzdotie jautājumi

Ko pārbauda rīks?

Tas pārbauda openapi vai swagger versiju, info.title un info.version, to, vai ceļi sākas ar slīpsvītru, vai katram {parameter} ceļā ir atbilstošs obligāts ceļa parametrs, un otrādi, parametru nosaukumus un atrašanās vietas, atbilžu statusa kodus un aprakstus, dublētus parametrus, dublētas operationId vērtības un to, vai katra lokālā $ref atsauce norāda uz elementu dokumentā.

Vai šī ir pilna specifikācijas JSON shēmas validācija?

Nē. Tiek pārbaudīti iepriekš minētie strukturālie noteikumi, kas palīdz atklāt lielāko daļu ar roku rakstītos dokumentos pieļauto kļūdu, taču netiek validēts katrs lauks atbilstoši oficiālajai metashēmai un netiek pārbaudīts jūsu shēmu saturs.

Ko rāda kopsavilkums?

Specifikācija un API versija, nosaukums, tabula ar visiem galapunktiem, to metodēm, ceļiem, operationId, kopsavilkumiem un atbilžu kodiem, kā arī shēmu nosaukumi sadaļā components.schemas vai Swagger 2.0 gadījumā — definitions.

Vai tiek sekots ārējām atsaucēm?

Nē. Atsauces uz citiem failiem vai URL netiek izgūtas un par tām netiek ziņots. Tiek atrisinātas tikai tās atsauces, kas sākas ar #, meklējot tās ielīmētajā dokumentā.

Kāda ir atšķirība starp kļūdām un brīdinājumiem?

Kļūdas norāda uz specifikācijas noteikuma pārkāpumu, piemēram, trūkstošu atbildes aprakstu vai nedeklarētu ceļa parametru. Brīdinājumi norāda uz atļautu, bet parasti netīši pieļautu situāciju, piemēram, GET operāciju ar pieprasījuma pamattekstu vai dokumentu bez operationId.

Vai OpenAPI 3.1 maina obligātās prasības?

Jā. OpenAPI 3.1 un 3.2 operācijai vairs nav nepieciešams responses objekts, un dokumentā paths vietā var būt webhooks vai components. Validators piemēro šos noteikumus, ja openapi lauks sākas ar 3.1 vai 3.2.

Par OneClick Pro

OneClick Pro ir bezmaksas vairāk nekā 150 tīmekļa rīku kolekcija ikdienas darbam: attēlu un mērvienību konvertēšanai, koda formatēšanai un validēšanai, domēnu un SEO pārbaudei, kā arī darbam ar tekstu, datumiem un skaitļiem. Katru rīku var izmantot bez reģistrācijas vai abonēšanas, un ievadītie dati tiek izmantoti tikai rezultāta aprēķināšanai un nekad netiek saglabāti. Izmantojiet to kā ātru rīku kopumu atsevišķiem uzdevumiem vai pievienojiet grāmatzīmēm rīkus, ko lietojat katru dienu.