Softonic

OpenAPI Spec Validator online

Stap 1 / 2
Volgende

Plak uw OpenAPI- of Swagger-specificatie hierboven om een lijst met fouten en waarschuwingen te krijgen. Deze pagina legt uit wat elk bericht betekent en hoe u het oplost, zodat u snel van een rood rapport naar een schoon rapport gaat. Fouten maken het document ongeldig; waarschuwingen doen dat niet.

Een specificatie controleren en het rapport opvolgen

  1. 1

    Plak de specificatie

    Plak uw document als JSON of YAML in het veld.

  2. 2

    Open de resultaten

    Ga naar de stap met resultaten om een geldig-bericht of een lijst met fouten te zien.

  3. 3

    Zoek elk bericht op

    Zoek het bericht in de tabel hieronder en pas de oplossing toe in uw bronbestand.

  4. 4

    Plak opnieuw

    Herhaal tot er geen fouten meer zijn en beslis daarna welke waarschuwingen het waard zijn om op te lossen.

De foutmeldingen lezen

Bericht Betekenis Oplossing
Kan niet als JSON of YAML worden gelezen. De tekst is in geen van beide formaten leesbaar Corrigeer de syntaxis: losse komma’s, verkeerde inspringing, niet-gesloten accolades
Versieveld ‘openapi’ of ‘swagger’ ontbreekt. Geen versiesleutel op het hoogste niveau Voeg openapi: 3.0.3 of swagger: "2.0" toe
Object ‘info’ ontbreekt. Geen sectie info Voeg info toe met titel en versie
info.title is verplicht. info heeft geen titel Voeg een title toe onder info
info.version is verplicht. info heeft geen versie Voeg een version toe onder info (uw API-versie)
Object ‘paths’ ontbreekt. Geen sectie paths Voeg paths toe, ook als het in het begin leeg is

Fouten bepalen of het document als geldig wordt gemeld. Los ze eerst allemaal op.

De waarschuwingen lezen

Bericht Betekenis Oplossing
Het pad ‘x’ moet met ‘/’ beginnen. Een sleutel onder paths heeft geen schuine streep vooraan Hernoem naar /x
Onbekende methode ‘x’ op /pad. Een sleutel onder een pad staat niet op de bekende lijst Controleer op een typefout, of negeer het als het een bewuste extensie of trace is

De bekende lijst bevat get, post, put, patch, delete, head, options, parameters, summary, description en servers. Leveranciersextensies die beginnen met x- staan er niet op, dus die verschijnen ook als waarschuwing.

Wat een online controle niet kan zeggen

Het rapport gaat alleen over de structuur. Het volgt geen $ref-verwijzingen, controleert geen schemadefinities en meldt geen ontbrekende operationId-waarden. Zie een geslaagde controle als bevestiging dat het bestand de vorm van een OpenAPI-document heeft, en gebruik een volledige linter voordat u documentatie publiceert of clientcode genereert.

Tips om een lang rapport af te werken

Begin bovenaan: een parseerfout betekent dat al het andere niet betrouwbaar is, dus los die eerst op. Pak daarna de ontbrekende velden op het hoogste niveau aan, want die zijn snel toegevoegd. Pas daarna kijkt u naar de padwaarschuwingen. Plak na elke ronde wijzigingen het hele bestand opnieuw in plaats van een fragment, want de controles hebben het volledige document nodig om info en paths te vinden. Een rapport zonder fouten en met een paar bewuste waarschuwingen is een normaal en acceptabel eindpunt.

Veelgestelde vragen

Fouten betekenen dat het document als niet geldig wordt gemeld. Waarschuwingen wijzen op punten die de moeite van een blik waard zijn, zoals een pad zonder schuine streep vooraan, maar ze veranderen het geldige resultaat niet.

Niet noodzakelijk. Het betekent dat de structuur op het hoogste niveau klopt. Schema’s, verwijzingen en responses worden niet onderzocht.

Sleutels onder een pad worden vergeleken met een vaste lijst van HTTP-methoden en enkele velden van het padonderdeel. Een x--sleutel staat er niet op en wordt daarom als waarschuwing gemarkeerd. U kunt hem laten staan.

Nee. Ze volgen de volgorde van de controles: eerst het versieveld, dan info en daarna paths. Er zijn geen regelnummers.

Gerelateerde tools

Webpack-configuratiegenerator

Maak een webpack.config.js voor webpack 5 voor gewoon JavaScript, React of Vue: TypeScript, Babel, CSS of Sass, afbeeldingen, HtmlWebpackPlugin, een devserver en de npm install-regel.

SVG-golfgenerator

Genereer een vloeiende SVG-golfscheiding voor headers en footers met instelbare amplitude, frequentie, kleur en positie boven of onder. Kopieer de SVG-code.

Protocol Buffers-decoder

Decodeer Protobuf-bytes lokaal uit hex, Base64, Base64URL, tekst of een bestand, bekijk veldinterpretaties en exporteer een privérapport.

XSD-validator

Valideer een XML-document tegen een XSD-schema en rapporteer discrepanties tussen elementen en typen, inclusief de exacte regelnummers.

XML-formatter

Maak XML-documenten netjes op met consistente inspringing en spoor welgevormdheidsfouten op met exacte regelnummers.

XML naar JSON

Zet XML-documenten om naar schone JSON, waarbij attributen, tekstknopen en arrays waar nodig behouden blijven. Drie stijlen: compact, Badgerfish of letterlijk.

Tool beschikbaar in andere talen

Handleidingen en toepassingen