Getting Started

Installation

npm

$ npm add @jsonapi-serde/openapi openapi3-ts zod

pnpm

$ pnpm add @jsonapi-serde/openapi openapi3-ts zod

yarn

$ yarn add @jsonapi-serde/openapi openapi3-ts zod

bun

$ bun add @jsonapi-serde/openapi openapi3-ts zod

Basic Setup

Import the functions you need from @jsonapi-serde/openapi and start building your OpenAPI schemas:

import { buildResourceRequestContentObject } from "@jsonapi-serde/openapi";
import { z } from "zod/v4";

const attributesSchema = z.object({
  name: z.string(),
  age: z.number().optional(),
});

const personRequestContentObject = buildResourceRequestContentObject({
  type: "person",
  attributesSchema,
});

console.log(personRequestContentObject);

This will generate a content object for your OpenAPI spec compliant with JSON:API standards.