Softonic

OpenAPI-specifikationsvalidator online

Steg 1 / 2
Nästa

Klistra in din OpenAPI- eller Swagger-specifikation ovan för att få en lista med fel och varningar. Den här sidan förklarar vad varje meddelande betyder och hur du åtgärdar det, så att du snabbt kan gå från en röd rapport till en ren. Fel gör dokumentet ogiltigt, varningar gör det inte.

Så kontrollerar du en specifikation och följer upp rapporten

  1. 1

    Klistra in specifikationen

    Klistra in ditt dokument som JSON eller YAML i fältet.

  2. 2

    Öppna resultatet

    Gå vidare till resultatsteget för att se antingen ett giltigt meddelande eller en lista med fel.

  3. 3

    Matcha varje meddelande

    Hitta meddelandet i tabellen nedan och tillämpa åtgärden i din källfil.

  4. 4

    Klistra in igen

    Kör om tills inga fel finns kvar och avgör sedan vilka varningar som är värda att åtgärda.

Så läser du felmeddelandena

Meddelande Betydelse Åtgärd
Could not parse as JSON or YAML. Texten går inte att läsa i något av formaten Rätta syntaxen: stray commas, fel indrag, oavslutade klammerparenteser
Missing ‘openapi’ or ‘swagger’ version field. Ingen versionsnyckel på översta nivån Lägg till openapi: 3.0.3 eller swagger: "2.0"
Missing ‘info’ object. Ingen info-sektion Lägg till info med title och version
info.title is required. info saknar title Lägg till en title under info
info.version is required. info saknar version Lägg till en version under info (din API-version)
Missing ‘paths’ object. Ingen paths-sektion Lägg till paths, även om den är tom till en början

Fel avgör om dokumentet redovisas som giltigt. Åtgärda alla först.

Så läser du varningarna

Meddelande Betydelse Åtgärd
Path ‘x’ should start with ‘/’. En nyckel under paths saknar inledande snedstreck Byt namn till /x
Unknown method ‘x’ on /path. En nyckel under en sökväg finns inte på listan över kända metoder Leta efter ett stavfel, eller ignorera om det är ett avsiktligt tillägg eller trace

Listan över kända nycklar är get, post, put, patch, delete, head, options, parameters, summary, description och servers. Tillägg från leverantörer som börjar med x- finns inte på listan, så de visas också som varningar.

Vad en online-kontroll inte kan avgöra

Rapporten täcker bara strukturen. Den följer inte $ref-länkar, kontrollerar inte schemadefinitioner och flaggar inte saknade operationId-värden. Se ett godkänt resultat som en bekräftelse på att filen har formen av ett OpenAPI-dokument, och använd en fullständig linter innan du publicerar dokumentation eller genererar klientkod.

Tips för att gå igenom en lång rapport

Börja högst upp: ett tolkningsfel gör att inget annat är pålitligt, så åtgärda det först. Ta sedan itu med saknade fält på översta nivån, eftersom de är snabba att lägga till. Titta först därefter på varningarna för sökvägar. Efter varje omgång redigering klistrar du in hela filen igen i stället för ett fragment, eftersom kontrollerna behöver hela dokumentet för att hitta info och paths. En rapport utan fel och med några avsiktliga varningar är ett normalt och godtagbart slutläge.

Vanliga frågor

Fel innebär att dokumentet redovisas som ogiltigt. Varningar pekar på saker som är värda en titt, till exempel en sökväg utan inledande snedstreck, men ändrar inte det giltiga resultatet.

Inte nödvändigtvis. Det betyder att strukturen på översta nivån är på plats. Scheman, referenser och svar granskas inte.

Nycklar under en sökväg jämförs med en fast lista över HTTP-metoder och några fält för sökvägsobjekt. En nyckel som börjar med x- finns inte på listan och flaggas därför som en varning. Du kan lämna den kvar.

Nej. De följer ordningen i kontrollerna: först versionsfältet, sedan info och sist paths. Det finns inga radnummer.

Relaterade verktyg

Webpack-konfigurationsgenerator

Skapa en webpack.config.js för webpack 5 med vanlig JavaScript, React eller Vue: TypeScript, Babel, CSS eller Sass, bilder, HtmlWebpackPlugin, en utvecklingsserver och raden för npm install.

Protocol Buffers-avkodare

Avkoda Protobuf-byte lokalt från hex, Base64, Base64URL, text eller fil, granska fälttolkningar och exportera en privat rapport.

XSD-validerare

Validera ett XML-dokument mot ett XSD-schema och rapportera element- och typavvikelser med exakta radnummer.

YAML till JSON

Omvandla YAML-konfiguration till JSON för verktyg och API:er som bara accepterar JSON. Hanterar ankare, merge-nycklar och nästlade strukturer.

XML-formaterare

Snygga till XML-dokument med konsekvent indrag och fånga formfel med exakta radnummer.

XML till JSON

Omvandla XML-dokument till ren JSON, med bevarade attribut, textnoder och arrayer där det behövs. Tre stilar: kompakt, Badgerfish eller literal.

Verktyget finns på andra språk

Guider och användningsområden