Skip to content

Mock Configuration

Mock configuration is used to define the mock response behavior of a single interface.

Basic Structure

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

export default defineMock({
  url: '/api/test',
  method: 'GET',
  body: { message: 'Hello World' }
})

Configuration Overview

ConfigurationTypeRequiredDefaultDescription
urlstringYes-Request path, supports dynamic parameters
methodMethod | Method[]No['GET','POST']Allowed HTTP methods
enabledbooleanNotrueWhether to enable
statusnumberNo200Response status code
statusTextstringNo'OK'Response status text
headersHeaders | FunctionNo-Response headers
bodyResponseBody | FunctionNo{}Response body
responseFunctionNo-Custom response handling
delaynumber | [number, number]No0Response delay
cookiesResponseCookies | FunctionNo-Response Cookies
validatorValidator | FunctionNo-Request validator
errorMockErrorConfigNo-Error simulation configuration

Multiple Configurations

Multiple mock configurations can be exported in a single file:

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

export default defineMock([
  {
    url: '/api/users',
    method: 'GET',
    body: []
  },
  {
    url: '/api/users',
    method: 'POST',
    body: { id: 1 }
  }
])

Detailed Documentation

View API Reference - MockHttpItem for complete configuration item descriptions and examples.

Released under the MIT License