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

软件过程资料模板-接口设计说明书 <项目编号/项目名称> 接口设计说明书 (版本号 VX.X) 更改履历 注:更改人除形成初稿，以后每次修改在未批准确认前均需采用修订 的方式进行修改。 项目名称 接口设计说明书 目 录 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 5 TUXEDO接 口 ......................................................................................................... 3 5.1 接口功能 1 ........................................................................................................... 3 5.1.1 接口子功能 1 ................................................................................................. 3 5.1.2 接口子功能 2 ................................................................................................. 4 6 WEBSERVICE服务接口 ....................................................................................... 4 6.1 接口综 述 .............................................................................................................. 4 杭 州朗新信息科技有限公司 版权所有2009 I 项目名称 接口设计说明书 6.1.1 WebService概 述 ............................................................................................ 4 6.1.2 认证机 制 ........................................................................................................ 5 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 II 杭州朗新信息科技有限公司 版权所有2009 项目名称 接口设计说明书 1 引言 1.1 设计目标 无相关图表的章节中，可自行根据需要加入图表说明，下同。 要达到的目的简述，例如说明需要支持的功能目标等。 1.2 适用范围 文档的适用范围，比如是在全公司适用还是在某个产品部适用等。预期的读者是哪些等。 1.3 相关术语 列出本文件中用到的专门术语的定义，例如中间库在本项目中的的含义，如果没有需特别要说明的，可删除此章节 1.4 参考资料 列出有关的参考资料 2 分析设计 2.1 设计思想 【说明本模块的基本设计概念，比如对需求是如何考虑的，为什么要把对应的需求转换成这样的设计处理，以及接口的概况性的描述、要求】 2.2 接口结构 说明接口的系统、功能的分布关系，优先图示说明，如果需要，可以列出接口功能清单。 杭州朗新信息科技有限公司 版权所有2009 1 项目名称 接口设计说明书 2.3 数据流分析 为说明数据流向描述功能模块实现对应需求的数据图,说明数据 经过处理后的输出传输情况。可选 3 中间库接口 通常不建议使用此接口方式实现，没有此接口方式可以删除此目录. 3.1 中间库说明 说明传输数据库版本等 3.2 传输交互方法 说明数据交互的频率、主动、触发等方式。 3.3 中间库接口结构 3.3.1 XXX1表/视图 如果是表采用下表描述结构 /视图 3.3.2 XXX2表 相关内容同表1 3.3.3 XXX1方法/函数 2 杭州朗新信息科技有限公司 版权所有2009 项目名称 接口设计说明书 4 页面集成接口 没有此接口方式可以删除此目录 4.1 对外提供 4.2 外部调用 5 Tuxedo接口 没有此接口方式可删除此章节目录。 5.1 接口功能1 如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。TUXDEO服务的使用表格描述。 5.1.1 接口子功能1 如果功能简单，此级目录可以不要，使用TUXDEO服务表格描述。 杭州朗新信息科技有限公司 版权所有2009 3 项目名称 接口设计说明书 TUXDO接口服务表格如下: 5.1.2 接口子功能2 结构示意如果功能简单，此级目录可以不要。 6 WebService服务接口 没有此接口方式可以删除此目录 6.1 接口综述 综述WebService接口相关的技术，如简介认证、压缩、数据规约及需要描述的一些规定等，根据需要增加下级目录说明，下述目录为建议性质. 6.1.1 WebService概述 本节可根据需要增删。 4 杭州朗新信息科技有限公司 版权所有2009 项目名称 接口设计说明书 6.1.2 认证机制 本节可根据需要增删。 说明认证机制 6.1.3 数据规约 说明格式约定、DTD等 6.2 接口功能1 如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。Webservice服务的使用表格描述。 6.2.1 接口子功能1 如果功能简单，此级目录可以不要，使用Webservice服务表格描述。 Webservice接口服务表格如下: 杭州朗新信息科技有限公司 版权所有2009 5 项目名称 接口设计说明书 7 文件接口 7.1 文件名称 说明传输文件的名称规则及格式，如MRDATA.DBF 7.2 文件格式定义 根据需要，说明文件的列分割，行分割等条件，建议用表格方式。例如字段可以使用下列表格。 7.3 传输方法 说明定期传递， FTP或者指定目录等，如果使用方法，则参照类似格 式: 杭州朗新信息科技有限公司 版权所有2009 6 项目名称 接口设计说明书 7.4 {其他约定} 标题名称自定，例如可以约定目录结构、某某内容等，自行扩展。 8 代码 约定的标准参数代码、返回代码等，自行扩展。 杭州朗新信息科技有限公司 版权所有2009 7