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

next-api-builder

v1.0.1

Published

An easy way to build API routes in Next.js with the right defaults.

Downloads

10

Readme

Next.js API Builder

An easy way to build API routes in Next.js with the right defaults.

Features:

  • Fully typed with TypeScript
  • Built-in schema validation with Zod
  • Automatic 400: Bad Request response when a Zod schema is supplied and the input data fails validation
  • Automatic OPTIONS response based on defined HTTP methods
  • Automatic HEAD response based on your defined GET handler
  • Automatic 405: Method Not Found response for requests to methods not handled

Installation

Install with NPM:

npm i next-api-builder

Or with Yarn:

yarn add next-api-builder

Usage

import { apiRoute } from 'next-api-builder';
import type { NextApiRequest, NextApiResponse } from 'next/types';

export default apiRoute()
  .get(async (req: NextApiRequest, res: NextApiResponse) => {
    return { foo: 'bar!' };
  })
  .post(async (req: NextApiRequest, res: NextApiResponse) => {
    // Insert data into some DB...
    return req.body || { id: 0, title: 'Sample record' };
  });

Using Zod.js for Runtime Validation

Next API builder uses Zod for runtime validation of a request body and/or query string parameters.

You can use a second optional object literal parameter when defining routes to supply a Zod schema.

  • validateBody - Parse the body as an object (from JSON, etc.) and run validations on it
  • validateQuery - Parse the query string and run validations on it
import { apiRoute } from 'next-api-builder';
import type { NextApiRequest, NextApiResponse } from 'next/types';

const schema = z.object({
  name: z.string(),
  email: z.string().email(),
});

type TSchema = z.infer<typeof schema>;

export default apiRoute().post(
  async (req: NextApiRequest, res: NextApiResponse, data: TSchema) => {
    // Insert data into some DB...
    return data || { id: 0, title: 'Sample record' };
  },
  { validateBody: schema }, // Use 'validateBody' or 'validateQuery' with a Zod schema object
);

If the incoming HTTP Request fails validation, a 400: Bad Request will be returned to the user with the field level errors and messages returned from Zod, formatted to JSON.