Skip to main content

Parameters

See plugin common configurations for configuration options available to all plugins.

  • delay

    integer

    default: 0


    Mock response delay in seconds.

  • response_status

    integer

    default: 200


    HTTP status code of the mock response.

  • content_type

    string

    default: application/json;charset=utf8


    Content-Type header of the mock response.

  • response_example

    string


    Response body of the mock response. Support the use of built-in variables in the body.

    At least one of the response_example and response_schema should be configured.

  • response_schema

    object


    Response JSON Schema. The JSON schema supports string, number, integer, boolean, object, and array in data types.

    At least one of the response_example and response_schema should be configured. response_schema is only effective when response_example is not configured.

  • with_mock_header

    boolean

    default: true


    If true, add a response header x-mock-by with APISIX version.

  • response_headers

    object


    Headers to be added in the mock response.