Skip to main content
Version: 2.14

mocking

描述#

mocking 插件用于模拟 API。当执行该插件时，它将随机返回指定格式的模拟数据，并且请求不会转发到上游。

属性#

名称类型必选项默认值描述
delayinteger否延时返回的时间，单位为秒。
response_statusinteger否200返回响应的 HTTP 状态码。
content_typestring否application/json返回响应的 Header Content-Type。
response_examplestring否返回响应的 Body，与 response_schema 字段二选一。
response_schemaobject否指定响应的 jsonschema 对象，未指定 response_example 字段时生效。
with_mock_headerboolean否true当设置为 true 时，将添加响应头 x-mock-by: APISIX/{version}。设置为 false 时则不添加该响应头。

JSON Schema 在其字段中支持以下类型：

  • string
  • number
  • integer
  • boolean
  • object
  • array

以下是一个 JSON Schema 示例：

{    "properties":{        "field0":{            "example":"abcd",            "type":"string"        },        "field1":{            "example":123.12,            "type":"number"        },        "field3":{            "properties":{                "field3_1":{                    "type":"string"                },                "field3_2":{                    "properties":{                        "field3_2_1":{                            "example":true,                            "type":"boolean"                        },                        "field3_2_2":{                            "items":{                                "example":155.55,                                "type":"integer"                            },                            "type":"array"                        }                    },                    "type":"object"                }            },            "type":"object"        },        "field2":{            "items":{                "type":"string"            },            "type":"array"        }    },    "type":"object"}

以下为上述 JSON Schema 可能生成的返回对象：

{    "field1": 123.12,    "field3": {        "field3_1": "LCFE0",        "field3_2": {            "field3_2_1": true,            "field3_2_2": [                155,                155            ]        }    },    "field0": "abcd",    "field2": [        "sC"    ]}

启用插件#

你可以通过如下命令在指定路由上启用 mocking 插件：

curl http://127.0.0.1:9080/apisix/admin/routes/1 \-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/index.html",    "plugins": {        "mocking": {            "delay": 1,            "content_type": "application/json",            "response_status": 200,            "response_schema": {               "properties":{                   "field0":{                       "example":"abcd",                       "type":"string"                   },                   "field1":{                       "example":123.12,                       "type":"number"                   },                   "field3":{                       "properties":{                           "field3_1":{                               "type":"string"                           },                           "field3_2":{                               "properties":{                                   "field3_2_1":{                                       "example":true,                                       "type":"boolean"                                   },                                   "field3_2_2":{                                       "items":{                                           "example":155.55,                                           "type":"integer"                                       },                                       "type":"array"                                   }                               },                               "type":"object"                           }                       },                       "type":"object"                   },                   "field2":{                       "items":{                           "type":"string"                       },                       "type":"array"                   }               },               "type":"object"           }        }    },    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:1980": 1        }    }}'

测试插件#

通过上述命令启用插件后，可以使用如下方式测试插件是否启用成功：

当 mocking 插件配置如下：

{  "delay":0,  "content_type":"",  "with_mock_header":true,  "response_status":201,  "response_example":"{\"a\":1,\"b\":2}"}

通过如下命令进行测试：

curl http://127.0.0.1:9080/test-mock -i
HTTP/1.1 201 CreatedDate: Fri, 14 Jan 2022 11:49:34 GMTContent-Type: application/json;charset=utf8Transfer-Encoding: chunkedConnection: keep-alivex-mock-by: APISIX/2.10.0Server: APISIX/2.10.0
{"a":1,"b":2}

禁用插件#

当你需要禁用 mocking 插件时，可以通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

curl http://127.0.0.1:9080/apisix/admin/routes/1 \-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/index.html",    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:1980": 1        }    }}'