# OpenAPI validaator

Kontrolli OpenAPI 3.0, 3.1 või 3.2 või Swagger 2.0 dokumenti YAML- või JSON-vormingus ning saa selle lõpp-punktide ja skeemide kokkuvõte. Validaator kontrollib kohustuslikke välju, teede malle ja teeparameetreid, parameetrite asukohti, vastusekoode, korduvaid operation ID-sid ning kõiki kohalikke $ref-viiteid. Iga probleem loetletakse koos asukohaga.

## Korduma kippuvad küsimused

### Mida valideerija kontrollib?

See kontrollib openapi või swaggeri versiooni, info.title ja info.version, seda, et teed algavad kaldkriipsuga ning et igal tee {parameter}-il on vastav kohustuslik teeparameeter ja vastupidi. Samuti kontrollib see parameetrite nimesid ja asukohti, vastuste olekukoode ja kirjeldusi, korduvaid parameetreid ning korduvaid operationId väärtusi, samuti seda, et iga kohalik $ref viitab dokumendis olevale elemendile.

### Kas see valideerib spetsifikatsiooni täielikult JSON skeemi alusel?

Ei. See kontrollib eespool kirjeldatud struktuurireegleid, mis aitavad leida enamiku käsitsi kirjutatud dokumentide vigu, kuid ei valideeri kõiki välju ametliku metaskeemi alusel ega kontrolli sinu skeemide sisu.

### Mida kokkuvõte näitab?

Spetsifikatsiooni ja API versiooni, pealkirja, tabelit kõigi lõpp-punktide kohta koos meetodi, tee, operationId, kokkuvõtte ja vastusekoodidega ning skeemide nimed jaotises components.schemas või Swagger 2.0 puhul jaotises definitions.

### Kas väliseid viiteid järgitakse?

Ei. Viiteid teistele failidele või URL-idele ei laadita alla ega näidata. Ainult #-iga algavad viited lahendatakse kleebitud dokumendi sees.

### Mis vahe on vigadel ja hoiatustel?

Vead rikuvad spetsifikatsiooni reeglit, näiteks puuduv vastuse kirjeldus või deklareerimata teeparameeter. Hoiatused osutavad lubatud asjadele, mis pole tavaliselt mõeldud, näiteks GET-toimingule koos päringu sisuga või operationId-ta dokumendile.

### Kas OpenAPI 3.1 muudab kohustuslikke elemente?

Jah. OpenAPI 3.1 ja 3.2 puhul ei vaja toiming enam responses-objekti ning dokumendis võib paths-jaotise asemel olla webhooks või components. Validaator rakendab neid reegleid, kui openapi välja väärtus algab numbriga 3.1 või 3.2.

Teie reklaam siin?

[Kirjutage meile](mailto:hi@dennn.is?subject=Reklaam%20OneClick%20Pro-is)

[Reklaam 433 tööriista teie tehisintellekti agentidele ühe MCP-serveri kaudu.](https://multitaskai.com/et/?ref=oneclickpro)
