Skip to content

Latest commit

 

History

History
236 lines (172 loc) · 5.95 KB

README.md

File metadata and controls

236 lines (172 loc) · 5.95 KB
Raw

fastify-zod

Why?

fastify is awesome and arguably the best Node http server around.

zod is awesome and arguably the best TypeScript modeling / validation library around.

Unfortunately, fastify and zod don't work together very well. fastify suggests using @sinclair/typebox, which is nice but is nowhere close to zod. This library allows you to use zod as your primary source of truth for models with nice integration with fastify, fastify-swagger and OpenAPI typescript-fetch generator.

Features

  • Define your models using zod in a single place, without redundancy / conflicting sources of truth
  • Use your models in busines logic code and get out of the box type-safety in fastify
  • First-class support for fastify-swagger and openapitools-generator/typescrip-fetch
  • Referential transparency, including for enums
  • Deduplication of structurally equivalent models
  • Internal generated JSON Schemas available for reuse

Setup

  • Install fastify-zod
npm i fastify-zod`
  • Define your models using zod
const TodoItemId = z.object({
  id: z.string().uuid(),
});
type TodoItemId = z.infer<typeof TodoItemId>;

enum TodoStateEnum {
  Todo = `todo`,
  InProgress = `in progress`,
  Done = `done`,
}

const TodoState = z.nativeEnum(TodoStateEnum);

const TodoItem = TodoItemId.extend({
  label: z.string(),
  dueDate: z.date().optional(),
  state: TodoState,
});

type TodoItem = z.infer<typeof TodoItem>;

const TodoItems = z.object({
  todoItems: z.array(TodoItem),
});
type TodoItems = z.infer<typeof TodoItems>;

const TodoItemsGroupedByStatus = z.object({
  todo: z.array(TodoItem),
  inProgress: z.array(TodoItem),
  done: z.array(TodoItem),
});

type TodoItemsGroupedByStatus = z.infer<typeof TodoItemsGroupedByStatus>;

const schema = {
  TodoItemId,
  TodoItem,
  TodoItems,
  TodoItemsGroupedByStatus,
};
  • Merge fastify types (as recommended by fastify)
import type { FastifyZod } from "fastify-zod";

declare module "fastify" {
  interface FastifyInstance {
    readonly zod: FastifyZod<typeof schema>;
  }
}
  • Generate JSON Schemas
import { buildJsonSchemas } from "fastify-zod";

const jsonSchemas = buildJsonSchemas(schema);
  • Register fastify-zod with optional config for fastify-swagger
import { register } from "fastify-zod";

const f = fastify();

register(f, {
  jsonSchemas,
  swagger: {
    routePrefix: `/openapi`,
    openapi: {
      info: {
        title: `Zod Fastify Test Server`,
        description: `API for Zod Fastify Test Server`,
        version: `0.0.0`,
      },
    },
    exposeRoute: true,
    staticCSP: true,
  },
});
  • Define fastify routes using simplified syntax and get automatic type inference
f.zod.post(
  `/item`,
  {
    operationId: `postTodoItem`,
    body: `TodoItem`,
    reply: `TodoItems`,
  },
  async ({ body: nextItem }) => {
    /* body is correctly inferred as TodoItem */
    if (state.todoItems.some((prevItem) => prevItem.id === nextItem.id)) {
      throw new BadRequest(`item already exists`);
    }
    state.todoItems = [...state.todoItems, nextItem];
    /* reply is typechecked against TodoItems */
    return state;
  }
);

API

buildJsonSchemas(schema: Schema, options: BuildJsonSchemasOptions = {})

Build JSON Schemas from Zod models.

Schema

Record mapping model keys to Zod types. Keys will be used to reference models in routes definitions.

Example:

const TodoItem = z.object({
  /* ... */
});
const TodoList = z.object({
  todoItems: z.array(TodoItem),
});

const schema = {
  TodoItem,
  TodoList,
};

BuildJsonSchemasOptions = {}

BuildJsonSchemasOptions.target = "jsonSchema7": jsonSchema7 (default) or openApi3

Generates either jsonSchema7 or openApi3 schema. See zod-to-json-schema.

buildJsonSchema($id: string, Type: ZodType) (deprecated)

Shorthand to buildJsonSchema({ [$id]: Type }).schemas[0].

register(f: FastifyInstance, { jsonSchemas, swagger: SwaggerOptions }: RegisterOptions)

Add schemas to fastify and decorate instance with zod property to add strongly-typed routes (see fastify.zod below).

swagger is optional but recommended as it enables strongly typed client generation together with openapitool-generator.

fastify.zod.(delete|get|head|options|patch|post|put)(url: string, config: RouteConfig, handler)

Add route with strong typing.

Example:

f.zod.put(
  "/:id",
  {
    operationId: "putTodoItem",
    params: "TodoItemId", // this is a key of "schema" object above
    body: "TodoItem",
    reply: {
      description: "The updated todo item",
      key: "TodoItem",
    },
  },
  async ({ params: { id }, body: item }) => {
    /* ... */
  }
);

Usage with openapitools

Together with fastify-swagger, this library supports downstream client code generation using openapitools-generator.

For this you need to first generate the spec file, then run openapitools-generator:

const spec = await f
  .inject({
    method: "get",
    url: "/openapi/json",
  })
  .then((spec) => spec.json());

writeFileSync("openapi-spec.json", JSON.stringify(spec), { encoding: "utf-8" });

We recommend running this as part as the build step of your app, see package.json.

Caveats

Schema flattening

Due to limitations in openapitools-generator, it is not possible to use JSON pointers (e.g. #!/components/schemas/my-schema/nested/path). To achieve downstream support, we "flatten" the generated JSON Schema to avoid using pointers. Hence the generated models tend to be relatively verbose, but should yet remain human-readable.

Discriminated unions

Limitations in openapitools-generator including discriminated / tagged unions limit the scope of models. Typing, validation, etc., will work as expected, but the generator will fail.

License

MIT License Copyright (c) 2022 Elie Rotenberg