Vite-plugin-koa-mock NPM

vite-plugin-koa-mock

English | 中文

Serve mock API with Koa.js in Vite projects.

logger

Install

npm install -D vite-plugin-koa-mock

Usage

Create mock/index.js and write mock API:

import { app } from 'vite-plugin-koa-mock'

app.use((ctx) => {
  ctx.body = 'bar'
})

Config vite.config.js:

import { defineConfig } from 'vite'
import KoaMock from 'vite-plugin-koa-mock'

import './mock/index' // necessary

export default defineConfig({
  plugins: [
    KoaMock({ proxyKeys: ['/api'] }),
  ],
})

Send requests in your application code:

const res = await fetch('/api/foo')
console.log(await res.text()) // -> bar

Options

import type { Options as CorsOptions } from '@koa/cors'

export interface KoaMockOptions {
  /**
   * The port of mock server.
   * @default 9719
   */
  port?: number

  /**
   * Keys for Vite's configuration `server.proxy`.
   * @see https://vitejs.dev/config/server-options.html#server-proxy
   * @default []
   */
  proxyKeys?: string[]

  /**
   * Whether to enable builtin logger middleware.
   * @default true
   */
  logger?: boolean

  /**
   * Whether to enable builtin CORS middleware.
   * You can configure the CORS middleware by setting an options object.
   * @see https://github.com/koajs/cors#corsoptions
   * @default true
   */
  cors?: boolean | CorsOptions

  /**
   * Whether to enable builtin body parser middleware.
   * @see https://github.com/koajs/bodyparser
   * @default true
   */
  bodyParser?: boolean
}

Koa middleware

The variable app imported in mock/index.js is a Koa instance, so you can set the Koa middleware you need for the app.

vite-plugin-koa-router export @koa/router as Router. This is an example of using router middleware:

import { Router, app } from 'vite-plugin-koa-mock'

const router = new Router()

router.get('/api/foo', (ctx) => {
  ctx.body = 'bar'
})

app.use(router.routes())
app.use(router.allowedMethods())