-
Notifications
You must be signed in to change notification settings - Fork 2.5k
RAP_v0.11_doc
Table of Contents generated with DocToc
- 需求概述
- 进度 & 分工 & 排期
- 需求详细设计
- ```
- - 名称 - 操作 -
- - 错误码 - 修改 删除 -
- - 日期规范 - 修改 删除 -
- - 人民币规范 - 修改 删除 -
- 技术详细设计
- 界面&交互设计
感谢国际站BU兄弟们的给力支持,我们即将在团队管理、项目之间的规范 & 模板共享上,作出重大的改进。同时,我们还会通过引入Blueprint API国际规范来将更多优秀的工具引入到RAP中。
截至到该文档撰写时,RAP仅在阿里内网就已服务于689
位工程师、252
项目,承载着1483
个接口定义。
随着用户&需求爆发式的快速增长,下一年度@RAP小组 的工作重心是:开放平台、业务合作、规范&工具互通。我们将以开放合作的心态来让RAP更加完善。欢迎多多提出issue和pull request。
在RAP v0.11中,我们将实现:
- 规范约束集
- 可以在团队(跨项目)级别管理规范约束,比如新建规范约束
『错误码』
,该错误码规范约束可以应用在任意字段中,并会影响Mock数据、数据校验,同时也方便了业务规范信息的管理
- 可以在团队(跨项目)级别管理规范约束,比如新建规范约束
- 接口模板集
- 在创建 & 编辑接口时可以选择模板,例如选择模板
{code : 200, data : $ref, msg : ""}
后,接口中的定义会出现在$ref位置,这对统一管理大量共性结构更加方便。
- 在创建 & 编辑接口时可以选择模板,例如选择模板
- 字段模板集
- 类似于接口模板,一些复杂、共性的字段,例如
{xxxBo : {x : 1, y : 2, z : 3}}
也可以使用字段模板统一管理起来。
- 类似于接口模板,一些复杂、共性的字段,例如
- BP规范接入
- Blueprint API是国外的基于Markdown的接口规范,目前已经有非常多的工具实现了该规范,RAP也将通过实现Blueprint API来打通各个接口管理功能。在v0.11中,我们首先实现RAP Model => Blueprint API的转换器,并引入第一批优秀的Blueprint API兼容的工具来完善RAP的功能。首批实现功能包含:Aglio(在线文档生成)、Dredd(后端持续集成&测试工具)、api-mock(第三方Mock工具)。
- Open API
- 我们将通过开放API数据来帮助其它需要接口数据的工具,例如我们和天猫IF-TEST合作为其自动化测试工具提供接口数据。本期我们将开放以下API,具体参文档的开放API部分。
- queryModel.do
获取RAP项目 => 接口级的数据
- querySchema.do
获取接口的详细JSON Schema
- queryRAPModel.do
获取项目级、带MockJS模板的RAP整个文档模型
- queryModel.do
- 我们将通过开放API数据来帮助其它需要接口数据的工具,例如我们和天猫IF-TEST合作为其自动化测试工具提供接口数据。本期我们将开放以下API,具体参文档的开放API部分。
- 其它改进
- 会包含一些UI界面的交互改进,并提升用户体验,修复已知问题。
- 增加功能的定制,非必需功能默认不显示,可在配置中心配置显示的UI功能。防止界面过于复杂。
TODO
TODO
TODO
- RAP Data => Blueprint API转换器
- RAP.node服务搭建
- Aglio接入
- api-mock接入 before 2014.10.30
- Dredd接入 before 2014.11.30
- queryModel API
- querySchema API
- queryRAPModel API
点击菜单栏中的『切换团队』可以看到团队下面的规范约束集管理列表(在产品线下方,页面结构和产品线类似)
-------------------------------------------------
- 名称 - 操作 -
-------------------------------------------------
- 错误码 - 修改 删除 -
-------------------------------------------------
- 日期规范 - 修改 删除 -
-------------------------------------------------
- 人民币规范 - 修改 删除 -
-------------------------------------------------
点击上部分的『错误码』,进入到错误码管理界面。
规范集
模板集由两部份组成,#1 模板入口 及 管理页 #2 现有项目及接口流程修改,接口模板
这一块主要满足数据结构的重用
及标准约定
。
右侧为新增版快的入口,点击团队模板进入模板管理
页面。
用户与团队之前可通过BU进行团队绑定,进行管理,以满足日常工作当中跨团队操作的需求。
左侧为团队模板,为了通用
及业务团队
两类,与RAP的接口操作一致。 点击未节点+增加
进行新增。
因接口模板为一般接口的一种通用提取操作,所以数据结构与接口数据一致,区别在于模板是基于团队的为标准
及高复用性接口
,而接口是基于项目和页面的。
如果引用接口模板
,第一步是在于项目创建时,基于项目所选择的团队进行相应的模板选择。
如果有个别接口不适用于项目中所选择的模板可进行去除或更改。
选择接口模板
后,接口详情的页面会套用相关的信息。 灰底的为模板中定义的结果,在模板定义中字段新增引用
类型以套用接口详情中新增的数据。
与接口模板
满足的需求不同,字段模板
主要是为了满足数据的重用
如一些业务上的领域模型
及标准数据定义
。
如下图一些业务对象定义的数据模型,在同一业务线的多个项目中都会被复用,针对业务把来务对象进行封装得出的数据模型我们称之来领域模型
即Domain model
与应用模型
即Application Model
对应。详情可阅读。
具体参见ISSUE19
具体参文档的开放API部分
TODO
####首页
####团队项目
####模板集
powered by Bosn@Alimama MUX
-
WIKI Home
- What is RAP
- Quick Guide
- User Manual
- Deploy Manual
- Dev Manual(writing)
- Wiki主页 (中文版)