Gå til indhold

OpenAPI-validator

Kontrollér et OpenAPI 3.0-, 3.1- eller 3.2-dokument eller et Swagger 2.0-dokument i YAML eller JSON, og få en oversigt over dets endpoints og skemaer. Validatoren kontrollerer de påkrævede felter, stiskabeloner op imod sti-parametre, parameterplaceringer, svarkoder, dublerede operation-ID'er og alle lokale $ref, og angiver placeringen af hvert problem.

Nulstil

Ofte stillede spørgsmål

Hvad kontrollerer validatoren?

Den kontrollerer openapi- eller swagger-versionen, info.title og info.version, at stier begynder med en skråstreg, at hver {parameter} i en sti har en tilsvarende påkrævet sti-parameter og omvendt, parameternavne og -placeringer, svarkoder og -beskrivelser, dublerede parametre og dublerede operationId-værdier samt, at hver lokal $ref peger på noget i dokumentet.

Er dette en fuld JSON-skemavalidering af specifikationen?

Nej. Den kontrollerer de strukturelle regler ovenfor, som fanger de fleste fejl i håndskrevne dokumenter, men den validerer ikke alle felter op imod det officielle metaschema eller kontrollerer indholdet af dine skemaer.

Hvad viser oversigten?

Specifikationen og API-versionen, titlen, en tabel over alle endpoints med deres metode, sti, operationId, oversigt og svarkoder samt navnene på skemaerne under components.schemas eller definitioner i Swagger 2.0.

Følger den eksterne referencer?

Nej. Referencer til andre filer eller URL'er hentes ikke og rapporteres ikke. Kun referencer, der begynder med #, løses i det indsatte dokument.

Hvad er forskellen mellem fejl og advarsler?

Fejl overtræder en specifikationsregel, f.eks. en manglende svardescription eller en sti-parameter, der ikke er erklæret. Advarsler peger på ting, der er tilladt, men som normalt ikke er tilsigtede, f.eks. en GET-operation med en request body eller et dokument uden operationId.

Ændrer OpenAPI 3.1, hvad der kræves?

Ja. I OpenAPI 3.1 og 3.2 behøver en operation ikke længere et responses-objekt, og et dokument kan have webhooks eller components i stedet for paths. Validatoren anvender disse regler, når openapi-feltet begynder med 3.1 eller 3.2.

Om OneClick Pro

OneClick Pro er en gratis samling med mere end 150 webværktøjer til daglige opgaver: konvertering af billeder og enheder, formatering og validering af kode, opslag af domæner og SEO samt arbejde med tekst, datoer og tal. Alle værktøjer fungerer uden registrering eller abonnement, og det, du indtaster, bruges kun til at beregne resultatet og gemmes aldrig. Brug samlingen som en hurtig værktøjskasse til enkeltstående opgaver, eller bogmærk de værktøjer, du bruger hver dag.