OpenAPI-validator
Kontrollera ett OpenAPI 3.0-, 3.1- eller 3.2-dokument eller ett Swagger 2.0-dokument i YAML eller JSON och få en sammanfattning av dess slutpunkter och scheman. Validatorn kontrollerar obligatoriska fält, sökvägsmönster mot sökvägsparametrar, parameterplatser, svarskoder, duplicerade operation-ID:n och varje lokal $ref, och listar varje problem med dess plats.
Vanliga frågor
Vad kontrollerar valideraren?
Den kontrollerar openapi- eller swagger-versionen, info.title och info.version, att sökvägar börjar med ett snedstreck, att varje {parameter} i en sökväg har en motsvarande obligatorisk sökvägsparameter och tvärtom, parameternamn och platser, svarsstatuskoder och beskrivningar, duplicerade parametrar, duplicerade operationId-värden samt att varje lokal $ref pekar på något i dokumentet.
Är detta en fullständig JSON-schemavalidering av specifikationen?
Nej. Den kontrollerar strukturreglerna ovan, som fångar de flesta misstag i handskrivna dokument, men validerar inte varje fält mot det officiella metaschemat eller kontrollerar innehållet i dina scheman.
Vad visar sammanfattningen?
Specifikationen och API-versionen, titeln, en tabell med alla slutpunkter och deras metod, sökväg, operationId, sammanfattning och svarskoder, samt schemanamnen under components.schemas eller definitionerna i Swagger 2.0.
Följs externa referenser?
Nej. Referenser till andra filer eller URL:er hämtas inte och rapporteras inte. Endast referenser som börjar med # löses i det inklistrade dokumentet.
Vad är skillnaden mellan fel och varningar?
Fel bryter mot en specifikationsregel, till exempel en saknad svarsbeskrivning eller en sökvägsparameter som inte har deklarerats. Varningar pekar på sådant som är tillåtet men vanligtvis oavsiktligt, till exempel en GET-operation med en begäran i kroppen eller ett dokument utan något operationId.
Ändrar OpenAPI 3.1 vad som krävs?
Ja. I OpenAPI 3.1 och 3.2 behöver en operation inte längre ett responses-objekt, och ett dokument kan ha webhooks eller components i stället för paths. Validatorn tillämpar dessa regler när openapi-fältet börjar med 3.1 eller 3.2.