From 60ba5c943470be499b7c72a0dfb2e9dbea91569f Mon Sep 17 00:00:00 2001 From: Bosn Date: Thu, 23 Jan 2014 10:55:51 +0800 Subject: [PATCH 1/3] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 升级插件文档 --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index aee6750..42b3037 100644 --- a/README.md +++ b/README.md @@ -14,28 +14,22 @@ Rigel Automation Platform RAP MOCK插件使用方法 -------------------------------------- -RAP提供MOCK服务插件（暂时仅支持Kissy和jQuery），使用方法如下。 +RAP提供MOCK服务插件（暂时仅支持Kissy和jQuery），使用方法只需要一步: -### 1. 在kissy, jQuery后面引入rap plugin ### +### 在kissy, jQuery后面引入rap plugin ### ```bash - + ``` -其中`{{projectId}}`为RAP提供的项目ID, `{{mode}}`为RAP路由的工作模式, 默认值为1。 -mode值及含义: +其中`{{id}}`为RAP提供的项目ID, `{{mode}}`为RAP路由的工作模式, 默认值为3，白名单会根据RAP中的文档自动配置，对RAP中未录入的接口不会做拦截。 +mode不同值具体含义: - 0 - 不拦截 - 1 - 拦截全部 - 2 - 黑名单中的项不拦截 - 3 - 仅拦截白名单中的项 -### 2. 引入mock.js ### - -```bash - -``` - -### 3. 设置黑名单、白名单（可选) ### +### 您也可以手动设置黑名单、白名单及查看、设置工作模式 ### 设置黑名单 @@ -51,4 +45,16 @@ RAP.setWhiteList(arr); 其中arr可以包含匹配字符串，或正则对象，例：['test', /test/g] +查看当前模式 + +```bash +RAP.getMode(); +``` + +设置当前模式 + +```bash +RAP.setMode(1); +``` + From 9c1c47573de0df98f2d90462846d695a74f59023 Mon Sep 17 00:00:00 2001 From: Bosn Date: Fri, 24 Jan 2014 14:53:42 +0800 Subject: [PATCH 2/3] Update README.md interface edit --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/README.md b/README.md index 42b3037..0552100 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,68 @@ Rigel Automation Platform -------------------------------------- 在前后端分离的开发模式下，我们通常需要一些`接口文档`来规范接口具体的返回格式。比如一个请求的链接是什么、有几个参数、参数类型、标识符、含义等等。`RAP` 首先方便您录入和管理这些接口文档，并通过分析文档数据为您生成自测数据、提供自测控制台、为自动化测试提供接口数据等等，大大提升开发效率。 + +起始工作 +-------------------------------------- + +### 一、首次登录 ### + +目前只支持域帐号登录，域帐号登录后会自动完成新用户如此及登录流程。后续我们会补充其它帐号的登录方式（RAP、微博、QQ等） + +### 二、创建项目 ### + +- 1. 进入RAP后，首先点击TOP菜单中的“团队切换”，选择自己的团队或公司。这些是由系统管理员预设的。 +- 2. 选择合适的业务线，您也可以在这里管理业务线。 +- 3. 进入业务线后，可在合适的分组下创建自己的项目。您也可以在这里管理自己的分组。 + +### 三、接口编辑 ### + +完成项目创建后，点击项目进入接口文档工作区，工作区分“编辑模式”和“查看模式（默认）”。首次进入，需要点击“启用编辑”，而后您可以根据界面的提示完成接口文档的编辑。首次进入项目系统会自动为您创建默认的第一个模块、页面和请求，请根据需求进行修改。 + +接口文档的结构： + +- 模块 (Module) 对应不同的Tab，用户可根据喜好进行设置。往往在大项目或接口较多的项目中使用频繁。比如可自己分账户模块、宝贝模块等等... +- 页面 (Page) 每个模块下有0至多个页面，RAP中的“页面”是逻辑页面，比如单页应用每一个View都可以算做一个页面，具体如何使用用户根据自己喜好设定即可。 +- 请求 (Action) 每个页面下有0至多个请求，RAP中的“请求”是接口文档最小单位，描述了一个WEB请求中的全部信息。 +- 参数 (Parameter) 每个请求中有请求参数列表和响应参数列表，参数是可以嵌套参数的，用以描述复杂的Object嵌套结构。 + +RAP的文档编辑像Excel编辑一样简单，具体见视频教程。 + +### 四、完成编辑 ### + +完成编辑后，可通过“快捷保存”直接完成保存，也可以通过普通的“保存”提交一些有用的注释信息。RAP的接口文档不同版本之间可以来回切换。您也可以通过“导出文档”功能将Word文档导出（Mac下请修改后缀名为html）。 + +自动化工具 +-------------------------------------- + +### for FE 之 MOCK ### + +RAP会通过文档数据自动为您创建MOCK服务并生成动态的模拟数据。您只需要通过一行代码引入插件，RAP会自动为您拦截在RAP中定义过的请求，具体见“RAP MOCK插件使用方法”。 + +默认，RAP会为不同数据类型生成默认的数据，您也可以通过手动编写标签实现更好的MOCK行为控制。例如字段 id 需要自增，您可以使用MockJS语法: + +变量名 备注 +id|+1 @mock=100 + +表示id从100开始，每次加1 + +具体请参加MockJS文档{{link}}，也可参考MockJS对接的例子{{link}}。 + +在编辑Mock规则时，请点击“显示Mock标签”，默认Mock信息会被隐藏，以使得接口文档更方便大多数人查看。 + +### for RD 之 Console ### + +RAP会根据接口文档数据自动为您创建控制台，它以页面为单位，您可以在这里方便的自测自己的实际开发的接口。它包含的功能： + +- 1. 自测功能，自动根据参数提供请求参数输入界面，后端方便自测 +- 2. 校验功能，对实际后端输出是否符合接口规范做校验，提示缺少、多余的字段 +- 3. 日志功能，提供日志分析，时间记录等 + +*注意：后端Console暂时仅支持JSONP，RAP v1.0会完成对同域接口自测的支持。 + +### for QA 之 API ### + +RAP开放了Mock规则的API，QA或对此有需求的同学可以通过RAP API去访问和编辑Mock规则，为自动化测试提供便利。 RAP MOCK插件使用方法 -------------------------------------- From 72bffb57472fae760135f1fd4dc1a5690abe7771 Mon Sep 17 00:00:00 2001 From: Bosn Date: Tue, 11 Feb 2014 14:37:21 +0800 Subject: [PATCH 3/3] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 整理文档 --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0552100..3680303 100644 --- a/README.md +++ b/README.md @@ -9,37 +9,37 @@ Rigel Automation Platform 什么是RAP? -------------------------------------- -在前后端分离的开发模式下，我们通常需要一些`接口文档`来规范接口具体的返回格式。比如一个请求的链接是什么、有几个参数、参数类型、标识符、含义等等。`RAP` 首先方便您录入和管理这些接口文档，并通过分析文档数据为您生成自测数据、提供自测控制台、为自动化测试提供接口数据等等，大大提升开发效率。 +在前后端分离的开发模式下，我们通常需要定义一份`接口文档`来规范接口的具体信息。如一个请求的地址、有几个参数、参数名称及类型含义等等。`RAP` 首先方便团队录入、查看和管理这些接口文档，并通过分析结构化的文档数据，重复利用并生成自测数据、提供自测控制台等等，很大的提升开发效率。 起始工作 -------------------------------------- -### 一、首次登录 ### +### 一、登录 & 注册 ### -目前只支持域帐号登录，域帐号登录后会自动完成新用户如此及登录流程。后续我们会补充其它帐号的登录方式（RAP、微博、QQ等） +目前只支持域帐号登录，域帐号登录后会自动完成新用户注册及登录流程。后续我们会补充其它帐号的登录方式（RAP、微博） ### 二、创建项目 ### -- 1. 进入RAP后，首先点击TOP菜单中的“团队切换”，选择自己的团队或公司。这些是由系统管理员预设的。 +- 1. 首先点击上方菜单中的“团队切换”，选择自己的团队或子公司。这些是由系统管理员预设的。 - 2. 选择合适的业务线，您也可以在这里管理业务线。 - 3. 进入业务线后，可在合适的分组下创建自己的项目。您也可以在这里管理自己的分组。 ### 三、接口编辑 ### -完成项目创建后，点击项目进入接口文档工作区，工作区分“编辑模式”和“查看模式（默认）”。首次进入，需要点击“启用编辑”，而后您可以根据界面的提示完成接口文档的编辑。首次进入项目系统会自动为您创建默认的第一个模块、页面和请求，请根据需求进行修改。 +完成项目创建后，点击项目链接进入`接口文档工作区`，工作区分`编辑模式`和`查看模式`（默认）。查看模式下会隐藏编辑UI使界面更方便查看，需要进行改动时只需点击右上角的“启用编辑”按钮，而后可根据界面提示完成接口文档的编辑工作。首次进入项目系统会自动为您创建默认的第一个模块、页面和请求，请根据需求进行修改。 接口文档的结构： -- 模块 (Module) 对应不同的Tab，用户可根据喜好进行设置。往往在大项目或接口较多的项目中使用频繁。比如可自己分账户模块、宝贝模块等等... -- 页面 (Page) 每个模块下有0至多个页面，RAP中的“页面”是逻辑页面，比如单页应用每一个View都可以算做一个页面，具体如何使用用户根据自己喜好设定即可。 -- 请求 (Action) 每个页面下有0至多个请求，RAP中的“请求”是接口文档最小单位，描述了一个WEB请求中的全部信息。 -- 参数 (Parameter) 每个请求中有请求参数列表和响应参数列表，参数是可以嵌套参数的，用以描述复杂的Object嵌套结构。 +- `模块 (Module)` 对应工作区不同的Tab，用户可根据喜好进行设置。往往在大项目或接口较多的项目中使用频繁。比如可自己分账户模块、宝贝模块等等... +- `页面 (Page)` 每个模块下有0至多个页面，RAP中的“页面”是逻辑页面，比如单页应用每一个View都可以算做一个页面，具体如何使用用户根据自己喜好设定即可。 +- `请求 (Action)` 每个页面下有0至多个请求，RAP中的“请求”是接口文档最小单位，描述了一个WEB请求中的全部信息。 +- `参数 (Parameter)` 每个请求中有请求参数列表和响应参数列表，参数是可以嵌套参数的，用以描述复杂的Object嵌套结构。 RAP的文档编辑像Excel编辑一样简单，具体见视频教程。 ### 四、完成编辑 ### -完成编辑后，可通过“快捷保存”直接完成保存，也可以通过普通的“保存”提交一些有用的注释信息。RAP的接口文档不同版本之间可以来回切换。您也可以通过“导出文档”功能将Word文档导出（Mac下请修改后缀名为html）。 +完成编辑后，可通过“快捷保存”直接完成保存，也可以通过普通的“保存”提交一些有用的注释信息。RAP的接口文档不同版本之间可以查看和永久切换。您也能通过“导出文档”功能将接口文档以Word文件方式导出（Mac下请修改后缀名为html）。 自动化工具 --------------------------------------