OpenAPI Helpers

Turn a JSON document into an OpenAPI schema, build an example from a schema, or check an example against one.

Voltar para todas as ferramentas

What to do OpenAPI version Detect formats Mark required keys Indentacao

JSON document

Example document

Saida

O resultado aparece aqui.

Funciona inteiramente no seu navegador.

Sobre esta ferramenta

Three things people do with an OpenAPI schema, on one page. "JSON to schema" infers a schema the same way the JSON Schema Generator does, then writes it in whichever OpenAPI dialect you pick: 3.1, where a schema object is JSON Schema itself, or 3.0, which has no type array and spells a nullable field as a single type plus nullable: true instead. "Schema to example" builds one JSON value that satisfies a schema, preferring an example or default the schema already states over inventing one. "Validate example" checks a document against a schema and lists every keyword it failed, resolving OpenAPI 3.0's nullable keyword first so a 3.0 schema is checked correctly rather than against JSON Schema's own type array rules. All three understand local $ref, allOf, anyOf and oneOf.

Como usar

Pick what you want: JSON to schema, schema to example, or validate an example.
Paste the input the mode asks for, or load the sample.
Press the button. Switch the OpenAPI version any time to see the same input written the other dialect's way.

Perguntas frequentes

What is different between OpenAPI 3.0 and 3.1 here?

Only how a nullable field is spelled. OpenAPI 3.1 adopted JSON Schema directly, so a field that can be null is a type array like ["string", "null"]. OpenAPI 3.0 predates that and has no type array at all, so the same field is one type plus a separate nullable: true keyword. Every other keyword this tool uses, properties, items, required, format, enum, allOf, anyOf, oneOf and $ref, means the same thing in both versions.

How is the example value chosen?

In order: an explicit example or examples on the schema, then a default, then a const, then the first enum value. Only once none of those are present does this build one from the type itself, a string for string, 0 or the stated minimum for a number, and so on, which is necessarily a guess about what a real value looks like rather than a fact the schema stated. A oneOf or anyOf picks its first branch; allOf merges every branch's properties and required list together.

Does this send my schema or document anywhere?

No. Every mode runs entirely in your browser, in a Web Worker so typing stays responsive even on a large schema. Nothing you paste here is ever sent to a server.

OpenAPI Helpers

Atalhos de teclado

Dados locais

Arquivos abertos recentemente

Compartilhar via link

Abrir o link compartilhado em