leslie-tsang commented on a change in pull request #5940: URL: https://github.com/apache/apisix/pull/5940#discussion_r786398848
########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,204 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local core = require("apisix.core") +local ngx = ngx +local xml2lua = require("xml2lua") +local string = string +local type = type + +local schema = { + type = "object", + properties = { + -- specify response delay time,default 0ms + delay = { type = "integer" }, + -- specify response status,default 200 + response_status = { type = "integer", default = 200, minimum = 1 }, + -- specify response content type,support application/xml,text/plain and application/json,default application/json Review comment: ```suggestion -- specify response content type, support application/xml, text/plain -- and application/json, default application/json ``` ########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,204 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local core = require("apisix.core") +local ngx = ngx +local xml2lua = require("xml2lua") +local string = string +local type = type + +local schema = { + type = "object", + properties = { + -- specify response delay time,default 0ms + delay = { type = "integer" }, + -- specify response status,default 200 + response_status = { type = "integer", default = 200, minimum = 1 }, + -- specify response content type,support application/xml,text/plain and application/json,default application/json + content_type = { type = "string", default = "application/json" }, + -- specify response body. + response_example = { type = "string" }, + -- specify response json schema,if response_example is not nil,this conf will be ignore. + -- generate random response by json schema. + response_schema = { type = "object" }, + with_mock_header = { type = "boolean", default = true } + }, + anyOf = { + { required = { "response_example" } }, + { required = { "response_schema" } } + } +} + +local _M = { + version = 0.1, + priority = 9900, + name = "mocking", + schema = schema, +} + +local function parse_content_type(content_type) + if not content_type then + return "", "" + end + local sep_idx = string.find(content_type, ";") + local typ, charset + if sep_idx then + typ = string.sub(content_type, 1, sep_idx - 1) + charset = string.sub(content_type, sep_idx + 1) + else + typ = content_type + end + return typ, charset +end + +function _M.check_schema(conf) + local ok, err = core.schema.check(schema, conf) + if not ok then + return false, err + end + + if conf.content_type == "" then + conf.content_type = "application/json;charset=utf8" + end + local typ, _ = parse_content_type(conf.content_type) + if typ ~= "application/xml" and + typ ~= "application/json" and + typ ~= "text/plain" and + typ ~= "text/html" and + typ ~= "text/xml" then + return false, "unsupported content type!" + end + return true +end + +local function gen_string(example) + if example ~= nil and type(example) == "string" then + return example + end + local n = math.random(1, 10) + local list = {} + for i = 1, n do + table.insert(list, string.char(math.random(97, 122))) + end + return table.concat(list) +end + +local function gen_number(example) + if example ~= nil and type(example) == "number" then + return example + end + return math.random() * 10000 +end + +local function gen_integer(example) + if example ~= nil and type(example) == "number" then + return math.floor(example) + end + return math.random(1, 10000) +end + +local function gen_boolean(example) + if example ~= nil and type(example) == "boolean" then + return example + end + local r = math.random(0, 1) + if r == 0 then + return false + end + return true +end + +local function gen_base(property) + local typ = string.lower(property.type) + local example = property.example + if typ == "string" then + return gen_string(example) + elseif typ == "number" then + return gen_number(example) + elseif typ == "integer" then + return gen_integer(example) + elseif typ == "boolean" then + return gen_boolean(example) + end + return nil +end + +function gen_array(property) + local output = {} + if property.items == nil then + return nil + end + local v = property.items + local n = math.random(1, 3) + local typ = string.lower(v.type) + for i = 1, n do + if typ == "array" then + table.insert(output, gen_array(v)) + elseif typ == "object" then + table.insert(output, gen_object(v)) + else + table.insert(output, gen_base(v)) + end + end + return output +end + +function gen_object(property) Review comment: Ditto ########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,204 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local core = require("apisix.core") +local ngx = ngx +local xml2lua = require("xml2lua") +local string = string +local type = type + +local schema = { + type = "object", + properties = { + -- specify response delay time,default 0ms + delay = { type = "integer" }, + -- specify response status,default 200 + response_status = { type = "integer", default = 200, minimum = 1 }, + -- specify response content type,support application/xml,text/plain and application/json,default application/json + content_type = { type = "string", default = "application/json" }, + -- specify response body. + response_example = { type = "string" }, + -- specify response json schema,if response_example is not nil,this conf will be ignore. + -- generate random response by json schema. + response_schema = { type = "object" }, + with_mock_header = { type = "boolean", default = true } + }, + anyOf = { + { required = { "response_example" } }, + { required = { "response_schema" } } + } +} + +local _M = { + version = 0.1, + priority = 9900, + name = "mocking", + schema = schema, +} + +local function parse_content_type(content_type) + if not content_type then + return "", "" + end + local sep_idx = string.find(content_type, ";") + local typ, charset + if sep_idx then + typ = string.sub(content_type, 1, sep_idx - 1) + charset = string.sub(content_type, sep_idx + 1) + else + typ = content_type + end + return typ, charset +end + +function _M.check_schema(conf) + local ok, err = core.schema.check(schema, conf) + if not ok then + return false, err + end + + if conf.content_type == "" then + conf.content_type = "application/json;charset=utf8" + end + local typ, _ = parse_content_type(conf.content_type) + if typ ~= "application/xml" and + typ ~= "application/json" and + typ ~= "text/plain" and + typ ~= "text/html" and + typ ~= "text/xml" then + return false, "unsupported content type!" + end + return true +end + +local function gen_string(example) + if example ~= nil and type(example) == "string" then + return example + end + local n = math.random(1, 10) + local list = {} + for i = 1, n do + table.insert(list, string.char(math.random(97, 122))) + end + return table.concat(list) +end + +local function gen_number(example) + if example ~= nil and type(example) == "number" then + return example + end + return math.random() * 10000 +end + +local function gen_integer(example) + if example ~= nil and type(example) == "number" then + return math.floor(example) + end + return math.random(1, 10000) +end + +local function gen_boolean(example) + if example ~= nil and type(example) == "boolean" then + return example + end + local r = math.random(0, 1) + if r == 0 then + return false + end + return true +end + +local function gen_base(property) + local typ = string.lower(property.type) + local example = property.example + if typ == "string" then + return gen_string(example) + elseif typ == "number" then + return gen_number(example) + elseif typ == "integer" then + return gen_integer(example) + elseif typ == "boolean" then + return gen_boolean(example) + end + return nil +end + +function gen_array(property) Review comment: ```suggestion local function gen_array(property) ``` ########## File path: docs/zh/latest/plugins/mocking.md ########## @@ -0,0 +1,232 @@ +--- +title: mocking +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +## 目录 + +- [**简介**](#简介) +- [**属性**](#属性) +- [**如何启用**](#如何启用) +- [**测试插件**](#测试插件) +- [**禁用插件**](#禁用插件) + +## 简介 + +Mock API插件，绑定该插件后将随机返回指定格式的mock数据，不再转发到后端。 + +## 属性 + +| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 | +| ------------- | -------| ----- | ----- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| delay | integer | 可选 | | | 延时返回的时间，单位为秒 | +| response_status | integer| 可选 | 200 | | 返回的响应http status code | +| content_type | string | 可选 | application/json | | 返回的响应头的Content-Type。 | +| response_example| string | 可选 | | | 返回的响应体，与response_schema二选一 | +| response_schema | object | 可选 | | | 指定响应的json schema对象，未指定response_body时生效，具体结构看后文说明 | +| with_mock_header | boolean | 可选 | true | | 是否返回响应头："x-mock-by: APISIX/{version}"，默认返回，指定为false则不返回 | + +支持的字段类型：`string`, `number`, `integer`, `boolean`, `object`, `array` +基础数据类型（string,number,integer,boolean）可通过配置example属性指定生成的响应值，未配置时随机返回。 +以下是一个json schema实例： + +```json +{ + "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可能生成的返回对象： + +```json +{ + "field1": 123.12, + "field3": { + "field3_1": "LCFE0", + "field3_2": { + "field3_2_1": true, + "field3_2_2": [ + 155, + 155 + ] + } + }, + "field0": "abcd", + "field2": [ + "sC" + ] +} +``` + +## 如何启用 + +这里以`route`为例(`service`的使用是同样的方法)，在指定的 `route` 上启用 `mocking` 插件。 + +```shell +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插件配置如下时： Review comment: ```suggestion 当 mocking 插件配置如下时： ``` ########## File path: docs/zh/latest/plugins/mocking.md ########## @@ -0,0 +1,232 @@ +--- +title: mocking +--- + +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +## 目录 + +- [**简介**](#简介) +- [**属性**](#属性) +- [**如何启用**](#如何启用) +- [**测试插件**](#测试插件) +- [**禁用插件**](#禁用插件) + +## 简介 + +Mock API插件，绑定该插件后将随机返回指定格式的mock数据，不再转发到后端。 + +## 属性 + +| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 | +| ------------- | -------| ----- | ----- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| delay | integer | 可选 | | | 延时返回的时间，单位为秒 | +| response_status | integer| 可选 | 200 | | 返回的响应http status code | +| content_type | string | 可选 | application/json | | 返回的响应头的Content-Type。 | +| response_example| string | 可选 | | | 返回的响应体，与response_schema二选一 | +| response_schema | object | 可选 | | | 指定响应的json schema对象，未指定response_body时生效，具体结构看后文说明 | +| with_mock_header | boolean | 可选 | true | | 是否返回响应头："x-mock-by: APISIX/{version}"，默认返回，指定为false则不返回 | + +支持的字段类型：`string`, `number`, `integer`, `boolean`, `object`, `array` +基础数据类型（string,number,integer,boolean）可通过配置example属性指定生成的响应值，未配置时随机返回。 +以下是一个json schema实例： + +```json +{ + "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可能生成的返回对象： + +```json +{ + "field1": 123.12, + "field3": { + "field3_1": "LCFE0", + "field3_2": { + "field3_2_1": true, + "field3_2_2": [ + 155, + 155 + ] + } + }, + "field0": "abcd", + "field2": [ + "sC" + ] +} +``` + +## 如何启用 + +这里以`route`为例(`service`的使用是同样的方法)，在指定的 `route` 上启用 `mocking` 插件。 + +```shell +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插件配置如下时： + +```json +{ + "delay":0, + "content_type":"", + "with_mock_header":true, + "response_status":201, + "response_example":"{\"a\":1,\"b\":2}" +} +``` + +curl访问将返回如下结果： +```shell +curl http://127.0.0.1:9080/test-mock -i Review comment: ```suggestion $ curl http://127.0.0.1:9080/test-mock -i ``` ########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,204 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local core = require("apisix.core") +local ngx = ngx +local xml2lua = require("xml2lua") +local string = string +local type = type Review comment: ```suggestion local type = type local table = table local math = math ``` ########## File path: apisix/plugins/mocking.lua ########## @@ -0,0 +1,204 @@ +-- +-- Licensed to the Apache Software Foundation (ASF) under one or more +-- contributor license agreements. See the NOTICE file distributed with +-- this work for additional information regarding copyright ownership. +-- The ASF licenses this file to You under the Apache License, Version 2.0 +-- (the "License"); you may not use this file except in compliance with +-- the License. You may obtain a copy of the License at +-- +-- http://www.apache.org/licenses/LICENSE-2.0 +-- +-- Unless required by applicable law or agreed to in writing, software +-- distributed under the License is distributed on an "AS IS" BASIS, +-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +-- See the License for the specific language governing permissions and +-- limitations under the License. +-- +local core = require("apisix.core") +local ngx = ngx +local xml2lua = require("xml2lua") +local string = string +local type = type + +local schema = { + type = "object", + properties = { + -- specify response delay time,default 0ms + delay = { type = "integer" }, + -- specify response status,default 200 + response_status = { type = "integer", default = 200, minimum = 1 }, + -- specify response content type,support application/xml,text/plain and application/json,default application/json + content_type = { type = "string", default = "application/json" }, + -- specify response body. + response_example = { type = "string" }, + -- specify response json schema,if response_example is not nil,this conf will be ignore. Review comment: ```suggestion -- specify response json schema, if response_example is not nil, this conf will be ignore. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
