npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

express-zod-oas

v0.1.3

Published

Express.js wrapper integrating Zod for request validation and automatic OpenAPI doc generation. Features TypeScript support, middleware compatibility, and built-in documentation UI options.

Downloads

9

Readme

Express Zod OAS

A powerful wrapper around Express.js that integrates Zod for request validation and automatic OpenAPI documentation generation.

Features

  • Built on top of Express.js
  • Zod integration for request validation (body, params, query)
  • Automatic OpenAPI (v3.1) specification generation
  • Built-in documentation UI options (Scalar and Redoc)
  • TypeScript support
  • Easy-to-use API for defining routes with OpenAPI metadata
  • Support for middleware
  • Mock example generation for request/response schemas

Installation

npm install express-zod-oas

Quick Start

import { Application, z } from 'express-zod-oas';

const app = new Application({
  openapi: {
    info: {
      title: 'My API',
      version: '1.0.0',
    },
  },
});

const UserSchema = z.object({
  id: z.string().uuid(),
  name: z.string(),
  email: z.string().email(),
});

app.openapi({
  method: 'get',
  path: '/users/:id',
  tags: ['Users'],
  operationId: 'getUserById',
  validate: {
    params: z.object({
      id: z.string().uuid(),
    }),
  },
  responses: {
    200: {
      description: 'Successful response',
      content: {
        type: 'application/json',
        schema: UserSchema,
      },
    },
  },
  handler: async (ctx) => {
    // Your handler logic here
    ctx.respond(200, { id: ctx.req.params.id, name: 'John Doe', email: '[email protected]' });
  },
});

app.listen(3000);

API Reference

Application

The main class for creating your application.

Constructor

new Application(options?: Partial<ApplicationOptions>)

Options:

  • openapi: OpenAPI specification options
  • docs: Configuration for documentation UI
  • jsonPath: Path to serve the OpenAPI JSON (default: '/api/openapi.json')
  • generateMockExamples: Whether to generate mock examples for schemas (default: true)

Methods

  • openapi<TBody, TParams, TQuery>(config: RouteConfig<TBody, TParams, TQuery>): Define a route with OpenAPI metadata
  • listen(port: number): Start the server
  • registerRouter(params: { prefix: string; router: Router; middlewares?: RequestHandler[] }): Register a router with a prefix
  • getSpec(): Get the OpenAPI specification object
  • getSpecAsJson(): Get the OpenAPI specification as a JSON string
  • getExpressApp(): Get the underlying Express application

Router

A class for creating modular route handlers.

Methods

  • openapi<TBody, TParams, TQuery>(config: RouteConfig<TBody, TParams, TQuery>): Define a route with OpenAPI metadata
  • getExpressRouter(): Get the underlying Express router
  • getRoutes(): Get all defined routes

Documentation

By default, the OpenAPI specification is served at /api/openapi.json.

Documentation UIs are automatically set up:

  • Scalar docs: /docs
  • Redoc: /redocly

To use Swagger UI, install the swagger-ui package and configure it to use the OpenAPI JSON URL or the specification object from application.getSpec().

Advanced Usage

Using Express Response

If you need to access the Express response object directly:

handler: async (ctx) => {
  ctx.res.status(200).json({ message: 'Hello, World!' });
}

Accessing the Underlying Express App

const expressApp = app.getExpressApp();

Disabling Mock Example Generation

const app = new Application({ generateMockExamples: false });

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License