Basic config examples for Mocking - Plugin - v3.7.x

You are browsing documentation for an outdated plugin version.

Basic configuration examples

Enable on a service

Enable on a route

Enable on a consumer

Enable globally

The following examples provide some typical configurations for enabling the mocking plugin on a service.

Kong Admin API

Konnect API

Kubernetes

Declarative (YAML)

Konnect Terraform

Make the following request:

curl -X POST http://localhost:8001/services/{serviceName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "mocking",
  "config": {
    "random_delay": true,
    "max_delay_time": 1,
    "min_delay_time": 0.001,
    "random_examples": true,
    "api_specification": "openapi: 3.0.1\ninfo:\n  title: OpenAPI 3.0 API\n  description: This is a simple API\n  contact:\n    email: example@example.com\n  version: 1.0.0\n"
  }
}
    '

Replace SERVICE_NAME|ID with the id or name of the service that this plugin configuration will target.

Make the following request, substituting your own access token, region, control plane ID, and service ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"mocking","config":{"random_delay":true,"max_delay_time":1,"min_delay_time":0.001,"random_examples":true,"api_specification":"openapi: 3.0.1\ninfo:\n  title: OpenAPI 3.0 API\n  description: This is a simple API\n  contact:\n    email: example@example.com\n  version: 1.0.0\n"}}'

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: mocking-example
plugin: mocking
config:
  random_delay: true
  max_delay_time: 1
  min_delay_time: 0.001
  random_examples: true
  api_specification: |
    openapi: 3.0.1
    info:
      title: OpenAPI 3.0 API
      description: This is a simple API
      contact:
        email: example@example.com
      version: 1.0.0
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the service as follows:

kubectl annotate service SERVICE_NAME konghq.com/plugins=mocking-example

Replace SERVICE_NAME with the name of the service that this plugin configuration will target. You can see your available ingresses by running kubectl get service.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: mocking
  service: SERVICE_NAME|ID
  config:
    random_delay: true
    max_delay_time: 1
    min_delay_time: 0.001
    random_examples: true
    api_specification: |
      openapi: 3.0.1
      info:
        title: OpenAPI 3.0 API
        description: This is a simple API
        contact:
          email: example@example.com
        version: 1.0.0

Replace SERVICE_NAME|ID with the id or name of the service that this plugin configuration will target.

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_mocking" "my_mocking" {
  enabled = true

  config = {
    random_delay = true
    max_delay_time = 1
    min_delay_time = 0.001
    random_examples = true
    api_specification = <<EOF
openapi: 3.0.1
info:
  title: OpenAPI 3.0 API
  description: This is a simple API
  contact:
    email: example@example.com
  version: 1.0.0
EOF
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

The following examples provide some typical configurations for enabling the mocking plugin on a route.

Kong Admin API

Konnect API

Kubernetes

Declarative (YAML)

Konnect Terraform

Make the following request:

curl -X POST http://localhost:8001/routes/{routeName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "mocking",
  "config": {
    "random_delay": true,
    "max_delay_time": 1,
    "min_delay_time": 0.001,
    "random_examples": true,
    "api_specification": "openapi: 3.0.1\ninfo:\n  title: OpenAPI 3.0 API\n  description: This is a simple API\n  contact:\n    email: example@example.com\n  version: 1.0.0\n"
  }
}
    '

Replace ROUTE_NAME|ID with the id or name of the route that this plugin configuration will target.

Make the following request, substituting your own access token, region, control plane ID, and route ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"mocking","config":{"random_delay":true,"max_delay_time":1,"min_delay_time":0.001,"random_examples":true,"api_specification":"openapi: 3.0.1\ninfo:\n  title: OpenAPI 3.0 API\n  description: This is a simple API\n  contact:\n    email: example@example.com\n  version: 1.0.0\n"}}'

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: mocking-example
plugin: mocking
config:
  random_delay: true
  max_delay_time: 1
  min_delay_time: 0.001
  random_examples: true
  api_specification: |
    openapi: 3.0.1
    info:
      title: OpenAPI 3.0 API
      description: This is a simple API
      contact:
        email: example@example.com
      version: 1.0.0
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the ingress as follows:

kubectl annotate ingress INGRESS_NAME konghq.com/plugins=mocking-example

Replace INGRESS_NAME with the name of the ingress that this plugin configuration will target. You can see your available ingresses by running kubectl get ingress.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: mocking
  route: ROUTE_NAME|ID
  config:
    random_delay: true
    max_delay_time: 1
    min_delay_time: 0.001
    random_examples: true
    api_specification: |
      openapi: 3.0.1
      info:
        title: OpenAPI 3.0 API
        description: This is a simple API
        contact:
          email: example@example.com
        version: 1.0.0

Replace ROUTE_NAME|ID with the id or name of the route that this plugin configuration will target.

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_mocking" "my_mocking" {
  enabled = true

  config = {
    random_delay = true
    max_delay_time = 1
    min_delay_time = 0.001
    random_examples = true
    api_specification = <<EOF
openapi: 3.0.1
info:
  title: OpenAPI 3.0 API
  description: This is a simple API
  contact:
    email: example@example.com
  version: 1.0.0
EOF
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

The following examples provide some typical configurations for enabling the mocking plugin on a consumer.

Kong Admin API

Konnect API

Kubernetes

Declarative (YAML)

Konnect Terraform

Make the following request:

curl -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "mocking",
  "config": {
    "random_delay": true,
    "max_delay_time": 1,
    "min_delay_time": 0.001,
    "random_examples": true,
    "api_specification": "openapi: 3.0.1\ninfo:\n  title: OpenAPI 3.0 API\n  description: This is a simple API\n  contact:\n    email: example@example.com\n  version: 1.0.0\n"
  }
}
    '

Replace CONSUMER_NAME|ID with the id or name of the consumer that this plugin configuration will target.

Make the following request, substituting your own access token, region, control plane ID, and consumer ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"mocking","config":{"random_delay":true,"max_delay_time":1,"min_delay_time":0.001,"random_examples":true,"api_specification":"openapi: 3.0.1\ninfo:\n  title: OpenAPI 3.0 API\n  description: This is a simple API\n  contact:\n    email: example@example.com\n  version: 1.0.0\n"}}'

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: mocking-example
plugin: mocking
config:
  random_delay: true
  max_delay_time: 1
  min_delay_time: 0.001
  random_examples: true
  api_specification: |
    openapi: 3.0.1
    info:
      title: OpenAPI 3.0 API
      description: This is a simple API
      contact:
        email: example@example.com
      version: 1.0.0
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the KongConsumer object as follows:

kubectl annotate KongConsumer CONSUMER_NAME konghq.com/plugins=mocking-example

Replace CONSUMER_NAME with the name of the consumer that this plugin configuration will target. You can see your available consumers by running kubectl get KongConsumer.

To learn more about KongConsumer objects, see Provisioning Consumers and Credentials.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: mocking
  consumer: CONSUMER_NAME|ID
  config:
    random_delay: true
    max_delay_time: 1
    min_delay_time: 0.001
    random_examples: true
    api_specification: |
      openapi: 3.0.1
      info:
        title: OpenAPI 3.0 API
        description: This is a simple API
        contact:
          email: example@example.com
        version: 1.0.0

Replace CONSUMER_NAME|ID with the id or name of the consumer that this plugin configuration will target.

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_mocking" "my_mocking" {
  enabled = true

  config = {
    random_delay = true
    max_delay_time = 1
    min_delay_time = 0.001
    random_examples = true
    api_specification = <<EOF
openapi: 3.0.1
info:
  title: OpenAPI 3.0 API
  description: This is a simple API
  contact:
    email: example@example.com
  version: 1.0.0
EOF
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer = {
    id = konnect_gateway_consumer.my_consumer.id
  }
}

A plugin which is not associated to any service, route, consumer, or consumer group is considered global, and will be run on every request.

In self-managed Kong Gateway Enterprise, the plugin applies to every entity in a given workspace.
In self-managed Kong Gateway (OSS), the plugin applies to your entire environment.
In Konnect, the plugin applies to every entity in a given control plane.

Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the Mocking plugin globally.

Kong Admin API

Konnect API

Kubernetes

Declarative (YAML)

Konnect Terraform

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "mocking",
  "config": {
    "random_delay": true,
    "max_delay_time": 1,
    "min_delay_time": 0.001,
    "random_examples": true,
    "api_specification": "openapi: 3.0.1\ninfo:\n  title: OpenAPI 3.0 API\n  description: This is a simple API\n  contact:\n    email: example@example.com\n  version: 1.0.0\n"
  }
}
    '

Make the following request, substituting your own access token, region, and control plane ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"mocking","config":{"random_delay":true,"max_delay_time":1,"min_delay_time":0.001,"random_examples":true,"api_specification":"openapi: 3.0.1\ninfo:\n  title: OpenAPI 3.0 API\n  description: This is a simple API\n  contact:\n    email: example@example.com\n  version: 1.0.0\n"}}'

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-mocking>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: "true"
config:
  random_delay: true
  max_delay_time: 1
  min_delay_time: 0.001
  random_examples: true
  api_specification: |
    openapi: 3.0.1
    info:
      title: OpenAPI 3.0 API
      description: This is a simple API
      contact:
        email: example@example.com
      version: 1.0.0
plugin: mocking

Add a plugins entry in the declarative configuration file:

plugins:
- name: mocking
  config:
    random_delay: true
    max_delay_time: 1
    min_delay_time: 0.001
    random_examples: true
    api_specification: |
      openapi: 3.0.1
      info:
        title: OpenAPI 3.0 API
        description: This is a simple API
        contact:
          email: example@example.com
        version: 1.0.0

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_mocking" "my_mocking" {
  enabled = true

  config = {
    random_delay = true
    max_delay_time = 1
    min_delay_time = 0.001
    random_examples = true
    api_specification = <<EOF
openapi: 3.0.1
info:
  title: OpenAPI 3.0 API
  description: This is a simple API
  contact:
    email: example@example.com
  version: 1.0.0
EOF
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Previous Mocking Configuration

Next Mocking Changelog