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

@readyplayerme/next-api-router

v1.4.4

Published

Simple utility allowing to route API endpoints by http methods with middleware functionality.

Downloads

68

Readme

Next.js API router

Simple utility allowing to route API endpoints by http methods with middleware functionality.

API

NextApiRouter

  • #create() - creates a NextApiRouter instance

NextApiRouter.prototype

  • #setLogger(logger: Console): this - sets a logger to be used by router. Default: console
  • #use(middleware): this - adds a middleware to execution pipeline. Middleware is a function receiving arguments as follows:
    • request: NextApiRequest
    • response: NextApiResponse
  • #post(handler)/#get(handler)/#put(handler)/#patch(handler)/#delete(handler)/#options() - adds a handler to requests with respective method. Handlers return value is sent as a response with status 200 unless response is already sent explicitly using Nextjs API. Handler is a function receiving arguments as follows:
    • request: NextApiRequest
    • response: NextApiResponse
  • #init() - initializer returning a Nextjs API handler which should exported by default from a Nextjs route endpoint file
  • #events - event emitter

Handler

Route handler can be added as a function or a configuration object:

export declare type NextApiRouterHandlerFn<T = any> = (
  this: NextApiRouterHandlerFnCtx,
  req: NextApiRequest,
  res: NextApiResponse<T>
) => T | Promise<T>;

or

export interface NextApiConfigurableHandlerOptions {
  schema?: ValidationSchema;
  middlewares?: NextApiRouterHandlerFn[];
  handler: NextApiRouterHandlerFn | NextApiRouterHandlerFn[];
}

Schema is jsonschema validating request/response payloads. Validation is omitted if schema is not provided. It is responding with 400 if request payload is not valid and 500 for response.

export interface ValidationSchema {
  query?: AnySchema;
  body?: AnySchema;
  response?: {
    [key: number]: AnySchema;
  };
}

It is possible to separately validate query, body and response payload by response code. E.g. the schema as follows is only validating response payloads with status 200. This schema is filtering out fields that are not specified and tries to cast types.

const schema = {
  response: {
    200: schema
  }
}

jsonschema is implemented using ajv with ajv-formats included.

Usage notes

  • it is possible to add multiple middlewares which would be executed in order of addition
  • handler is executed after a middleware
  • middleware added before handler is ignored
  • pipeline execution stops if middleware ends a request
  • it is possible to subscribe to error events (e.g. for reporting/logging purposes)

Example

const router = NextApiRouter.create() // or new NextApiRouter()
    .use(function (request: NextApiRequest, response: NextApiResponse) { // Add a middleware
      this.user = { id: 1, name: 'John Doe'} // middlewares and handlers share common context
    })
    .post(function (request: NextApiRequest, response: NextApiResponse) {
      return this.user // respond with some payload
    })
    // this middleware is only added to a subsequent handerlr.
    // E.g. it is called before get handler below but not the post one above
    .use(middleware)
    .get(handler)

router.events.on("error", (error) => /* process error */)

export default router.init()

Roadmap

  • add endpoint generic typing for request