OpenAPI Validator
Patikrinkite OpenAPI 3.0, 3.1, 3.2 arba Swagger 2.0 dokumentą, pateiktą YAML arba JSON formatu, ir gaukite jo galinių taškų bei schemų suvestinę. Tikrintuvas patikrina privalomus laukus, kelių šablonų atitiktį kelio parametrams, parametrų vietas, atsakymų kodus, pasikartojančius operacijų ID ir visas vietines $ref nuorodas, o kiekvieną problemą pateikia su jos vieta.
Dažnai užduodami klausimai
Ką tikrina tikrintuvas?
Jis tikrina openapi arba swagger versiją, info.title ir info.version, ar keliai prasideda pasviruoju brūkšniu, ar kiekvienas kelio {parameter} turi atitinkantį privalomą kelio parametrą ir atvirkščiai, parametrų pavadinimus bei vietas, atsakymų būsenų kodus ir aprašymus, pasikartojančius parametrus, pasikartojančias operationId reikšmes ir ar kiekviena vietinė $ref nuoroda nurodo į elementą dokumente.
Ar tai pilnas specifikacijos JSON Schema tikrinimas?
Ne. Tikrinamos anksčiau nurodytos struktūrinės taisyklės, padedančios aptikti daugumą ranka parašytuose dokumentuose pasitaikančių klaidų, tačiau netikrinamas kiekvienas laukas pagal oficialią meta schemą ir netikrinamas jūsų schemų turinys.
Ką rodo suvestinė?
Specifikacijos ir API versiją, pavadinimą, visų galinių taškų lentelę su jų metodais, keliais, operationId, suvestinėmis ir atsakymų kodais bei schemų pavadinimus, esančius components.schemas, arba Swagger 2.0 apibrėžtyse.
Ar sekamos išorinės nuorodos?
Ne. Nuorodos į kitus failus ar URL neatsisiunčiamos ir apie jas nepranešama. Dokumente, kurį įklijavote, išsprendžiamos tik # prasidedančios nuorodos.
Kuo skiriasi klaidos ir įspėjimai?
Klaidos reiškia, kad pažeista specifikacijos taisyklė, pavyzdžiui, trūksta atsakymo aprašymo arba nedeklaruotas kelio parametras. Įspėjimai nurodo leidžiamus, bet paprastai netyčinius dalykus, pavyzdžiui, GET operaciją su užklausos turiniu arba dokumentą be operationId.
Ar OpenAPI 3.1 keičia privalomus elementus?
Taip. OpenAPI 3.1 ir 3.2 operacijai nebereikia responses objekto, o dokumente vietoje paths gali būti webhooks arba components. Tikrintuvas taiko šias taisykles, kai openapi laukas prasideda 3.1 arba 3.2.