JSON Schema

Converting to JSON schema has especially poor and haphazard support across the ecosystem. @webroute/schema exports JSON schema converted for most popular schema libraries.

For example, using zod

import { ZodJsonSchemaFormatter } from "@webroute/schema/zod";
 
const toJsonSchema = ZodJsonSchemaFormatter();
 
const jsonSchema = toJsonSchema(
  z.object({
    a: z.number(),
  })
);
// {
// 		type: "object",
// 		properties: {
// 			a: { type: "number" }
// 		},
// 		required: true
// }

How does this work?

Since we have a formatter for TypeBox, we get JSON schema transformation for free.

TypeBox is built atop JSON schema, so any parsers can subsequently be formatted into TypeBox form.

import { createFormatter, createParser } from "@webroute/schema";
import { TypeBoxFormatter } from "@webroute/schema/typebox";
 
// Parse the schema
const parser = createParser(/** TODO: Add parser */);
const schemaDef = parser.parse(Schema);
 
// Format to TypeBox
const formatter = createFormatter(TypeBoxFormatter());
 
const jsonSchema = formatter.format(schemaDef);

Alternatively, we can import this out-of-the-box with the <library>JsonSchemaFormatter functions.

// e.g.
import { ZodJsonSchemaFormatter } from "@webroute/schema/zod";

This is especially helpful in conjunction with the @webroute/oas package.

JSON Schema

How does this work?

On this page