REST模式的网站接口开发设计.docVIP

Portal 接口开发指南 版本变动说明 版本号 发布时间 发布人 简介 0.7 2010-11-19 朱叶峰 增加ExecuteAudit 方法，支持触发工作流审核行为 0.6 2010-06-23 朱叶峰 在Query上增加qlcid参数；所有的table的检索支持id,名称,快捷码三种查询方式（以前仅支持id）；增加ExecuteSQL命令, 增加ExecuteBatch命令 0.5 2009-11-10 朱叶峰 增加ObjectUnsubmit 命令，修改了rest.jsp关于检索字段的名称定义，ObjectCreate 额外增加单据编号字段的读取控制。 0.4 2009-10-24 朱叶峰 增加GetObject命令，修改ProcessOrder?命令2009-10-21 朱叶峰 完成各命令的接口定义和resthome帮助页面的开发 0.1 2009-10-12 朱叶峰 初始设计 摘要 本文用于描述Portal 4.0的实时接口，能够支持应用程序通过HTTP请求的方式操作业务数据，完成数据的更新和检索等操作。接口以REST模式设计，以JSON，而不是XML为主要数据封装格式。 目录 Portal 接口开发指南 1 1.1 概述 1 1.1.1 设计思想 1 1.1.2 Portal 框架简介 2 1.2 身份认证 2 1.3 数据格式 3 1.3.1 必选参数 3 1.3.2 业务参数 3 1.3.3 返回内容 3 1.4 命令 4 1.4.1 ObjectCreate 4 1.4.2 ObjectModify 4 1.4.3 ObjectDelete 5 1.4.4 ObjectSubmit 5 1.4.5 ObjectUnsubmit 5 1.4.6 ProcessOrder 6 1.4.7 ExecuteWebAction 7 1.4.8 Import 7 1.4.9 Query 8 1.4.10 GetObject 10 1.4.11 ExecuteSQL 10 1.4.12 ExecuteBatch 11 概述 设计思想 我们将可快速开发作为首要设计出发点。 目前的web 接口主要有以下几种方式 xml-rpc soap rest 作为轻量级的接口设计模型，rest具有开发快速，接口完全自定义的特点，考虑以此模式进行。 由于网站接口的上传和下载数据都比较大，封装这些数据的方法在XML 和 JSON 之间考虑，JSON的特点就是简单，相比 XML 有以下问题： 1. 没有命名空间 namespace 2. 不像xml 那样区分属性attribute和元素element 3. 不支持属性的排放顺序控制 我们的系统里不存在多个namespace，且都可以element来显示，另外用数组来控制元素间的顺序，以JSON来封装数据是可行的。 在服务器上给出专用URL来处理所有接口内容: http://portal.server/servlets/binserv/Rest 同时在服务器以下位置可以获取到与业务单据相关的接口内容说明： http://portal.server/html/nds/schema/resthome.jsp 在以下位置进行数据封装测试： http://portal.server/html/nds/schema/testrest.jsp Portal 框架简介 数据描述 Portal底层的表一般包括主键(PK)和候选键（AK）, 显示键（DK）和业务字段。 PK: 统一命名为ID, NUMBER(10) AK: 一般为字符串，在一个公司帐套内唯一（PORTAL支持多公司帐套），唯一性主要通过数据库的UNIQUE INDEX实现。 DK: 一般为用户更好理解的业务内容，例如，员工表，AK为编号，DK一般选择员工姓名，但姓名是可能重复的，而编号必定唯一。 对于业务字段，一般FK类型的字段都以_ID结尾，前缀一般就是关联表的表名。 ColumnLink: 指通过FK关联关系逐级引用的表的关系，例如： Users 用户表的字段 C_CUSTOMER_ID 为FK指向 C_CUSTOMER客户表的ID字段，客户表上的RANK_ID字段为FK指向 C_RANK 客户等级的ID字段。则： USERS.C_CUSTOMER_ID;RANK_ID;DESC 就是一条COLUMNLINK, 表示将获取当前用户对应的客户的等级描述字段。通常忽略主表名称USERS，以 C_CUSTOMER_ID;RANK_ID;DESC即为COLUMNLINK的定义 界面视图构架 在Portal上可以完成底层同一张表的多视图构建。比如底层有业务伙伴表，通过建立“供应商”，“批发商”，“零售商”等视图将业