软件工程过程资料模板-接口设计说明书.doc

接口设计说明书接口设计说明书 版本号 VX X 更改履历 版本号版本号修改编号修改编号更改时间更改时间 更改的更改的 图表和章节号图表和章节号 更改简要描述更改简要描述更改人更改人批准人批准人 注 更改人除形成初稿 以后每次修改在未批准确认前均需采用修订的方式 进行修改 项目名称接口设计说明书 杭州朗新信息科技有限公司 版权所有 2009I 目 录 1引言引言 1 1 1设计目标 1 1 2适用范围 1 1 3相关术语 1 1 4参考资料 1 2分析设计分析设计 1 2 1设计思想 1 2 2接口结构 1 2 3数据流分析 2 3中间库接口中间库接口 2 3 1中间库说明 2 3 2传输交互方法 2 3 3中间库接口结构 2 3 3 1 XXX1 表 视图 2 3 3 2 XXX2 表 视图 2 3 3 3 XXX1 方法 函数 2 4页面集成接口页面集成接口 3 4 1对外提供 3 4 2外部调用 3 5TUXEDO 接口接口 3 5 1接口功能 1 3 5 1 1 接口子功能 1 3 5 1 2 接口子功能 2 4 6WEBSERVICE 服务接口服务接口 4 6 1接口综述 4 项目名称 接口设计说明书 II杭州朗新信息科技有限公司 版权所有 2009 6 1 1 WebService 概述 4 6 1 2 认证机制 4 6 1 3 数据规约 5 6 2接口功能 1 5 6 2 1 接口子功能 1 5 7文件接口文件接口 6 7 1文件名称 6 7 2文件格式定义 6 7 3传输方法 6 7 4 其他约定 7 8标准代码标准代码 7 项目名称接口设计说明书 杭州朗新信息科技有限公司 版权所有 20091 1引言 1 1 设计目标 无相关图表的章节中 可自行根据需要加入图表说明 下同 要达到的目的简述 例如说明需要支持的功能目标等 1 2 适用范围 文档的适用范围 比如是在全公司适用还是在某个产品部适用等 预期的读 者是哪些等 1 3 相关术语 列出本文件中用到的专门术语的定义 例如中间库在本项目中的的含义 如 果没有需特别要说明的 可删除此章节 术语术语解释解释 1 4 参考资料 列出有关的参考资料 2分析设计 2 1 设计思想 说明本模块的基本设计概念 比如对需求是如何考虑的 为什么要把对应的需求转换成这 样的设计处理 以及接口的概况性的描述 要求 2 2 接口结构 说明接口的系统 功能的分布关系 优先图示说明 如果需要 可以列出接 口功能清单 项目名称 接口设计说明书 2杭州朗新信息科技有限公司 版权所有 2009 2 3 数据流分析 为说明数据流向描述功能模块实现对应需求的数据流程图 说明数据经过处理 后的输出传输情况 可选 3中间库接口 通常不建议使用此接口方式实现 没有此接口方式可以删除此目录 3 1 中间库说明 说明传输数据库版本等 3 2 传输交互方法 说明数据交互的频率 主动 触发等方式 3 3 中间库接口结构 3 3 1 XXX1 表 视图 如果是表采用下表描述结构 序序 号号 字段中文名字段中文名字段英文名字段英文名字段类型字段类型字段含义字段含义 1 抄表接口数据 标识 DATA IDNUMBER 15 本实体记录的唯一标识 产生规 则为流水号 下装时填写 2申请编号APP NO VARCHAR2 16 流程实例的唯一标识 可自行编 码 下装时填写 3 3 2 XXX2 表 视图 相关内容同表 1 3 3 3 XXX1 方法 函数 功能说明功能说明提供客户的基本信息查询 调用位置调用位置所在的包 直接调用存储过程或函数不用说明 函数方法函数方法 参数代码参数代码数据类型数据类型参数说明参数说明输入参数输入参数 项目名称接口设计说明书 杭州朗新信息科技有限公司 版权所有 20093 参数代码参数代码数据类型数据类型参数说明参数说明输出参数输出参数 示例示例使用开发代码举例说明如何调用 4页面集成接口 没有此接口方式可以删除此目录 4 1 对外提供 序序 号号 功能说明功能说明页面调用路径页面调用路径入参入参出参出参 备注备注 1 可说明调用的 示例等 2 4 2 外部调用 序序 号号 功能说明功能说明页面调用路径页面调用路径入参入参出参出参 备注备注 1 可说明提供方 的相关信息 2 5Tuxedo 接口 没有此接口方式可删除此章节目录 5 1 接口功能 1 如提供给银行的 查询电费 功能 一些需要说明的信息在此说明 如果功能 比较复杂 可以根据需要设立下级子功能的目录结构 TUXDEO 服务的使用表格 描述 5 1 1 接口子功能 1 如果功能简单 此级目录可以不要 使用 TUXDEO 服务表格描述 Comment xsw1 增加 项目名称 接口设计说明书 4杭州朗新信息科技有限公司 版权所有 2009 TUXDO 接口服务表格如下 服务名称服务名称说明服务的 CODE 和名称 描述描述 参数名称参数名称数据长度数据长度参数说明参数说明 输入参数输入参数 参数名称参数名称数据长度数据长度参数说明参数说明 输出参数输出参数 错误信息错误信息 部署情况部署情况 示例示例使用开发代码举例说明如何调用 5 1 2 接口子功能 2 结构示意如果功能简单 此级目录可以不要 6WebService 服务接口 没有此接口方式可以删除此目录 6 1 接口综述 综述 WebService 接口相关的技术 如简介认证 压缩 数据规约及需要描述 的一些规定等 根据需要增加下级目录说明 下述目录为建议性质 6 1 1 WebService 概述 本节可根据需要增删 Comment xsw2 表格合并 Comment xsw3 表格合并 Comment xsw4 增加 项目名称接口设计说明书 杭州朗新信息科技有限公司 版权所有 20095 6 1 2 认证机制 本节可根据需要增删 说明认证机制 6 1 3 数据规约 说明格式约定 DTD 等 6 2 接口功能 1 如提供给银行的 查询电费 功能 一些需要说明的信息在此说明 如果功能 比较复杂 可以根据需要设立下级子功能的目录结构 Webservice 服务的使用表 格描述 6 2 1 接口子功能 1 如果功能简单 此级目录可以不要 使用 Webservice 服务表格描述 Webservice 接口服务表格如下 方法名称方法名称说明服务的 CODE 和名称 描述描述 发布路径发布路径 参数代码参数代码参数名称参数名称数据类型数据类型参数说明参数说明 输入参数输入参数 参数代码参数代码参数名称参数名称数据类型数据类型参数说明参数说明 输出参数输出参数 错误信息错误信息 部署情况部署情况 示例示例使用开发代码举例说明如何调用 项目名称 接口设计说明书 6杭州朗新信息科技有限公司 版权所有 2009 7文件接口 7 1 文件名称 说明传输文件的名称规则及格式 如 MRDATA DBF 7 2 文件格式定义 根据需要 说明文件的列分割 行分割等条件 建议用表格方式 例如字段 可以使用下列表格 序号序号字段中文名字段中文名字段英文名字段英文名字段类型字段类型字段含义字段含义 1 抄表接口数 据标识 DATA IDNUMBER 15 本实体记录的唯一标识 产生规 则为流水号 下装时填写 2申请编号APP NO VARCHAR2 16 流程实例的唯一标识 可自行编 码 下装时填写 7 3 传输方法 说明定期传递 FTP 或者指定目录等 如果使用方法 则参照类似格式 功能说明功能说明向抄表机中传输文件 调用位置调用位置例如 DLL OCX 等文件的路径名称等 如 sendFileToHc dll 函数方法函数方法Public String qryOwe String szStringRequest throws RemoteException Uexception Exception 参数代码参数代码 名称名称数据类型数据类型参数说明参数说明 PORTchar通讯端口号 参见标准代码 PORT NO BAUDRAT E char通讯波特率 参见标准代码 BAUD RATE 输入参数输入参数 参数代码参数代码 名称名称数据类型数据类型参数说明参数说明输出参数输出参数 示例示例int SendFileToHc char PORT char BAUDRATE char DATAFILE char APPFILE char PROMPT SendFileToHc 1 05 C F1 DBF F2 DBF C F3 dwn F4 mid 1 注 参数 1 1 表述端口号为 COM1 见标准代码 PORT NO 参数 2 05 表示波特率为 115 2k 见