# OpenAPI-validaattori

Tarkista OpenAPI 3.0-, 3.1- tai 3.2-dokumentti tai Swagger 2.0 -dokumentti muodossa YAML tai JSON ja saa yhteenvedon sen päätepisteistä ja skeemoista. Validaattori tarkistaa pakolliset kentät, polkumallien ja polkuparametrien vastaavuuden, parametrien sijainnit, vastauskoodit, päällekkäiset operation ID:t ja kaikki paikalliset $ref-viittaukset. Se luettelee ongelmat ja niiden sijainnit.

## Usein kysytyt kysymykset

### Mitä tarkistin tarkistaa?

Se tarkistaa openapi- tai swagger-version, info.title- ja info.version-kentät, että polut alkavat kauttaviivalla, että jokaisella polussa olevalla {parameter}-merkinnällä on sitä vastaava pakollinen polkuparametri ja päinvastoin, parametrien nimet ja sijainnit, vastausten tilakoodit ja kuvaukset, päällekkäiset parametrit, päällekkäiset operationId-arvot sekä sen, että jokainen paikallinen $ref osoittaa johonkin dokumentissa olevaan kohteeseen.

### Validoidaanko määritys kokonaisuudessaan JSON-skeemaa vasten?

Ei. Se tarkistaa yllä kuvatut rakennesäännöt, jotka paljastavat useimmat käsin kirjoitettujen dokumenttien virheet, mutta se ei validoi jokaista kenttää virallista metaskemaa vasten eikä tarkista skeemojesi sisältöä.

### Mitä yhteenveto näyttää?

Määrityksen ja API-version, otsikon, kaikkien päätepisteiden taulukon, jossa näkyvät metodi, polku, operationId, yhteenveto ja vastauskoodit, sekä skeemojen nimet kohdassa components.schemas tai Swagger 2.0:n definitions-kohdassa.

### Seurataanko ulkoisia viittauksia?

Ei. Viittauksia muihin tiedostoihin tai URL-osoitteisiin ei haeta eikä niistä ilmoiteta. Vain viittaukset, jotka alkavat merkillä #, ratkaistaan liitetyssä dokumentissa.

### Mitä eroa on virheillä ja varoituksilla?

Virheet rikkovat määrityksen sääntöä, esimerkiksi vastauskuvauksen puuttumista tai määrittelemätöntä polkuparametria. Varoitukset koskevat sallittuja mutta yleensä tahattomia asioita, kuten GET-operaatiota, jolla on pyyntörunko, tai dokumenttia, josta puuttuu operationId.

### Muuttuuko vaadittu sisältö OpenAPI 3.1:ssä?

Kyllä. OpenAPI 3.1:ssä ja 3.2:ssa operaatiolla ei enää tarvitse olla responses-objektia, ja dokumentissa voi olla webhooks- tai components-kohteita paths-kohteiden sijaan. Validaattori soveltaa näitä sääntöjä, kun openapi-kentän arvo alkaa merkkijonolla 3.1 tai 3.2.

Mainospaikka vapaana?

[Lähetä meille sähköpostia](mailto:hi@dennn.is?subject=Mainostaminen%20palvelussa%20OneClick%20Pro)

[Mainos 433 työkalua tekoälyagenteillesi yhden MCP-palvelimen kautta.](https://multitaskai.com/fi/?ref=oneclickpro)
