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-openapi-router

v0.0.2

Published

A thin wrapper around Express to validate requests and generate OpenAPI documentation.

Downloads

4

Readme

Express Zod OpenAPI Router

A thin wrapper around Express to validate requests and generate OpenAPI documentation.

Features

  • Drop-in replacement for Express.js Router
  • Validate request bodies and query parameters with Zod
  • Generate OpenAPI documentation from route definitions and Zod schemas

Installation

npm install express-zod-openapi
pnpm add express-zod-openapi

Example

Examples can be run with EXAMPLE={name} pnpm example, see more examples in the examples directory.

import express from 'express';
import { z } from 'zod';
import { createDocument, operation, Router } from 'express-zod-openapi-router';

const app = express();
const router = Router();

app.use(express.json());
app.use(router);

const Query = z.object({
  name: z.string().default('world').openapi({
    description: 'The name to say hello to',
    example: 'John Smith'
  }),
});

router.get('/hello', operation({
  summary: 'Say hello',
  description: 'Say hello to the world',
  query: Query,
}, (req, res) => {
  res.json({ message: `Hello, ${req.query.name}!` });
  //                                ^^^^^ { name: string }
}));

const document = createDocument({
  title: 'Hello World',
  version: '1.0.0',
  servers: [{ url: 'http://localhost:3000' }],
}, router);

app.use('/openapi.json', (req, res) => {
  res.json(document);
});

app.listen(3000, () => {
  console.log('Listening on http://localhost:3000');
});

Limitations

  • Only supports application/json bodies for documentation. However, other content types can be validated against by implementing middleware that transforms the body into an object of the right shape.
  • Does not support RegExp paths, only string and string[].