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

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