API Reference

This section provides the complete API reference documentation for vite-plugin-mock-dev-server, including detailed descriptions of all type definitions, helper functions, and configuration options.

Helper Functions

Function	Description
mockDevServerPlugin	Create Mock Dev Server plugin
defineMock	Type helper function for defining Mock configurations
createDefineMock	Create a custom defineMock function
defineMockData	Define shareable Mock data
createSSEStream	Create Server-Sent Events stream

Type Definitions

Type	Description
MockServerPluginOptions	Plugin configuration options
MockHttpItem	HTTP Mock configuration item
MockRequest	Extended request object
MockResponse	Extended response object

Quick Navigation

Plugin Configuration

import { mockDevServerPlugin } from 'vite-plugin-mock-dev-server'

export default defineConfig({
  plugins: [
    mockDevServerPlugin({
      prefix: ['/api'],
      dir: 'mock',
      // ... more configurations
    })
  ]
})

Mock Configuration

import { defineMock } from 'vite-plugin-mock-dev-server'

export default defineMock({
  url: '/api/user',
  method: 'GET',
  body: { id: 1, name: 'John' }
})

Shared Data

import { defineMock, defineMockData } from 'vite-plugin-mock-dev-server'

const users = defineMockData('users', [
  { id: 1, name: 'John' },
  { id: 2, name: 'Jane' }
])

export default defineMock({
  url: '/api/users',
  body: () => users.value
})