diff --git a/doc/page/usage/mock.md b/doc/page/usage/mock.md index 80a5faa7..93f8d2fc 100644 --- a/doc/page/usage/mock.md +++ b/doc/page/usage/mock.md @@ -32,8 +32,10 @@ ``` -## yapiMock跟mockjs区别 -因为yapi基于json定义mock,无法使用mockjs原有的函数功能,正则表达式需要基于rule书写,示例如下: +## YApi Mock 跟 mockjs 区别 + +1 因为 yapi 基于 json 定义 mock ,无法使用 mockjs 原有的函数功能,正则表达式需要基于 rule 书写,示例如下: + ``` { "name|regexp": "[a-z0-9_]+?", @@ -42,6 +44,16 @@ ``` +2 支持替换请求的query,body参数 + +``` +{ + "name": "${query.name}", //请求的url是/path?name=xiaoming, 返回的name字段是xiaoming + "type": "${body.type}" //请求的requestBody type=1,返回的type字段是1 +} + +``` + ## 如何使用Mock? ### 1 在js代码直接请求yapi提供的mock地址(不用担心跨域问题) 在代码直接请求yapi提供的mock地址,以jQuery为例: diff --git a/static/doc/index-使用mock功能.html b/static/doc/index-使用mock功能.html index a8d5c7ad..27b4bc7f 100644 --- a/static/doc/index-使用mock功能.html +++ b/static/doc/index-使用mock功能.html @@ -118,7 +118,7 @@
因为yapi基于json定义mock,无法使用mockjs原有的函数功能,正则表达式需要基于rule书写,示例如下:
+1 因为 yapi 基于 json 定义 mock ,无法使用 mockjs 原有的函数功能,正则表达式需要基于 rule 书写,示例如下:
{
"name|regexp": "[a-z0-9_]+?",
"type|regexp": "json|text|xml" //枚举数据类型可这样实现
}
+
2 支持替换请求的query,body参数
+{
+ "name": "${query.name}", //请求的url是/path?name=xiaoming, 返回的name字段是xiaoming
+ "type": "${body.type}" //请求的requestBody type=1,返回的type字段是1
+}
在代码直接请求yapi提供的mock地址,以jQuery为例:
let prefix = 'http://yapi.local.qunar.com:3000/mock/2817'
$.post(prefix+'/baseapi/path', {username: 'xxx'}, function(res){