Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
整理文档
  • Loading branch information
Bosn committed Feb 11, 2014
1 parent 9c1c475 commit 72bffb5
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)。

自动化工具
--------------------------------------
Expand Down

0 comments on commit 72bffb5

Please sign in to comment.