Next-api-mw NPM

size-url size-url2 npm-v ]npm-url]gh-url

About The Project

Consuming API middleware should be as easy as using hooks in React. When using next-api-mw you can abstract common logic like auth or verifying query params into a middleware that can be used inside of an API route.

When calling middleware inside your route, that middleware may either return a promise, or handle the request itself thereby stopping the rest of the handler and or middleware from running.

Getting Started

npm i next-api-mw

import { HandlerFactory, createMiddleware } from 'next-api-mw'

// create one handler factory, then export it so you can create handlers for all your routes
export const handlerFactory = new HandlerFactory({
  handleError: async ({req,res,e}) => {
    res.status(500).json({ msg: 'server error' })
  },
  logger: async ({req,res,e}) => {

  },
  rootMiddleware: async ({req, res, end}) => {
    if(req.url.includes('token')){
      res.status(200).json({msg: 'token-accepted'})
      end()
    }
  }
})

// middleware can be consumed in as many routes as you want
// you can even use one middleware inside of another
const usingFooQS = createMiddleware(async ({req, res, end}) => {
  const { foo } = req.query

  if (!foo || typeof foo !== 'string') {
    res.status(400).json({ msg: 'invalid foo' })
    // the res will be sent and the remainder of this handler and the next middleware will not be evaluated
    end()
  }

  return foo as string
})

// default export a handler in any file under page/api
export default handlerFactory.getHandler(async ({req, res, end}) => {
  // you may consume middleware inside of get handler
  const foo = await usingFooQS({req, res})
  res.status(200).json({ foo })
  end()
})