Ga naar de inhoud

OpenAPI Validator

Controleer een OpenAPI 3.0-, 3.1- of 3.2-document of een Swagger 2.0-document in YAML of JSON en krijg een overzicht van de endpoints en schema's. De validator controleert verplichte velden, path-templates aan de hand van path-parameters, parameterlocaties, responscodes, dubbele operation-ID's en elke lokale $ref, en vermeldt elk probleem met de locatie.

Resetten

Veelgestelde vragen

Wat controleert de validator?

De validator controleert de openapi- of swagger-versie, info.title en info.version, of paths met een slash beginnen, of elke {parameter} in een path een overeenkomende verplichte path-parameter heeft en omgekeerd, parameternamen en -locaties, HTTP-statuscodes en beschrijvingen van responses, dubbele parameters, dubbele operationId-waarden en of elke lokale $ref verwijst naar iets in het document.

Is dit een volledige validatie van de JSON Schema-specificatie?

Nee. De validator controleert de bovenstaande structurele regels, waarmee de meeste fouten in handgeschreven documenten worden opgespoord. De validator valideert echter niet elk veld aan de hand van het officiële metaschema en controleert ook de inhoud van je schema's niet.

Wat laat het overzicht zien?

De specificatie- en API-versie, de titel, een tabel met elk endpoint en de bijbehorende methode, path, operationId, samenvatting en responscodes, en de namen van de schema's onder components.schemas of, bij Swagger 2.0, onder definitions.

Worden externe verwijzingen gevolgd?

Nee. Verwijzingen naar andere bestanden of URL's worden niet opgehaald of gerapporteerd. Alleen verwijzingen die met # beginnen, worden binnen het geplakte document opgelost.

Wat is het verschil tussen fouten en waarschuwingen?

Fouten zijn overtredingen van een regel uit de specificatie, zoals een ontbrekende responsebeschrijving of een path-parameter die niet is gedeclareerd. Waarschuwingen wijzen op zaken die zijn toegestaan, maar meestal niet de bedoeling zijn, zoals een GET-bewerking met een request body of een document zonder operationId.

Verandert OpenAPI 3.1 wat verplicht is?

Ja. In OpenAPI 3.1 en 3.2 heeft een bewerking geen responses-object meer nodig en kan een document webhooks of components hebben in plaats van paths. De validator past die regels toe wanneer het openapi-veld begint met 3.1 of 3.2.

Over OneClick Pro

OneClick Pro is een gratis verzameling van meer dan 150 webtools voor dagelijks werk: afbeeldingen en eenheden converteren, code opmaken en valideren, domeinen en SEO controleren, en werken met tekst, datums en getallen. Elke tool werkt zonder registratie of abonnement. Wat u invoert, wordt alleen gebruikt om uw resultaat te berekenen en wordt nooit opgeslagen. Gebruik de verzameling als snelle gereedschapskist voor eenmalige taken of maak een bladwijzer van de tools die u dagelijks gebruikt.