vite-plugin-vercel-api v0.4.0

vite-plugin-vercel-api

Mimics Vercel's /api functionality locally. No need to be online or run vercel dev. You can simply run npm run dev to start Vite locally and use the /api directory the same way Vercel parses it in production.

This plugin provides 2 main features:

1. Traverses the /api directory at the root of your project and parses files the same way Vercel does in production.
2. Adds a number of middleware features found on the request and response objects in Vercel's serverless functions.

See https://nextjs.org/docs/api-routes/dynamic-api-routes for how the logic works for the /api directory, its files, and its folder structure.

Please note that Vercel /api features do NOT have parity with Next.js /pages/api. In particular, Vercel does not support [...catchAll] or [[...optionaCatchAll]] routes - see https://github.com/vercel/community/discussions/947.

See https://vercel.com/docs/runtimes#official-runtimes/node-js/node-js-request-and-response-objects for what middleware Vercel exposes on the request and response objects in serverless functions.

Installation

npm i -D vite-plugin-vercel-api

Usage

import {defineConfig} from 'vite'
import vitePluginVercelApi from 'vite-plugin-vercel-api'

export default defineConfig({
  plugins: [vitePluginVercelApi()],
})

Or with require syntax:

const {defineConfig} = require('vite')
const vitePluginVercelApi = require('vite-plugin-vercel-api')

module.exports = defineConfig({
  plugins: [vitePluginVercelApi()],
})

Options

apiDir

Vercel looks for files in the api directory. This plugin will also default to looking for an api folder. If you want to direct this plugin to process a differnt folder, this is the option for you.

debugOptions

This option will log values and errors of the build process to the console. This is a good way to debug what's happening under the hood. Using this option will override the config with clearScreen: true.

• true - shorthand for including all logging options.
• 'apiFiles' - log the files used for api endpoints.
• 'apiPath' - log the path used for the api.
• 'apiRoutes' - log the routes constructed for Express.
• 'buildResults' - log the esbuild results. Uses console.log which does not log deeply nested object values.
• 'buildResultsDeep' - log the esbuild results. Uses console.dir which does log deeply nested object values. NOTE: this can lead to large logs in the console!
• 'failedRouteImports' - log errors encountered with dynamically importing the route handler files.

Example usage:

import {defineConfig} from 'vite'
import vitePluginVercelApi from 'vite-plugin-vercel-api'

export default defineConfig({
  plugins: [
    vitePluginVercelApi({
      apiDir: 'myApi',
      debugOptions: ['apiFiles', 'buildResultsDeep', 'failedRouteImports'],
    }),
  ],
})