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

1、接口设计说明书接口设计说明书（版本号 VX.X）更改履历版本号版本号修改编号修改编号更改时间更改时间更改的更改的图表和章节号图表和章节号更改简要描述更改简要描述更改人更改人批准人批准人注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。项目名称接口设计说明书杭州朗新信息科技有限公司 版权所有 2009I目 录1引言引言.11.1设计目标.11.2适用范围.11.3相关术语.11.4参考资料.12分析设计分析设计.12.1设计思想.12.2接口结构.12.3数据流分析.23中间库接口中间库接口.23.1中间库说明.23.2传输交互方法.23.3中间库接口结构.23.3.1

2、 XXX1 表/视图.23.3.2 XXX2 表/视图.23.3.3 XXX1 方法/函数.24页面集成接口页面集成接口.34.1对外提供.34.2外部调用.35TUXEDO 接口接口.35.1接口功能 接口子功能 接口子功能 2.46WEBSERVICE 服务接口服务接口.46.1接口综述.4项目名称 接口设计说明书II杭州朗新信息科技有限公司 版权所有 20096.1.1 WebService 概述.46.1.2 认证机制.46.1.3 数据规约.56.2接口功能 接口子功能 1.57文件接口文件接口.67.1文件名称.67.2文件格式

3、定义.67.3传输方法.67.4其他约定.78标准代码标准代码.7项目名称接口设计说明书杭州朗新信息科技有限公司 版权所有 200911引言1.1 设计目标无相关图表的章节中，可自行根据需要加入图表说明，下同。要达到的目的简述，例如说明需要支持的功能目标等。1.2 适用范围文档的适用范围，比如是在全公司适用还是在某个产品部适用等。预期的读者是哪些等。1.3 相关术语列出本文件中用到的专门术语的定义，例如中间库在本项目中的的含义，如果没有需特别要说明的，可删除此章节术语术语解释解释1.4 参考资料列出有关的参考资料2分析设计2.1 设计思想【说明本模块的基本设计概念，比如对需求是如何考虑的，为什

4、么要把对应的需求转换成这样的设计处理，以及接口的概况性的描述、要求】2.2 接口结构说明接口的系统、功能的分布关系，优先图示说明，如果需要，可以列出接口功能清单。项目名称 接口设计说明书2杭州朗新信息科技有限公司 版权所有 20092.3 数据流分析为说明数据流向描述功能模块实现对应需求的数据流程图,说明数据经过处理后的输出传输情况。可选3中间库接口通常不建议使用此接口方式实现，没有此接口方式可以删除此目录.3.1 中间库说明说明传输数据库版本等3.2 传输交互方法说明数据交互的频率、主动、触发等方式。3.3 中间库接口结构3.3.1 XXX1 表/视图如果是表采用下表描述结构序序号号字段中文

5、名字段中文名字段英文名字段英文名字段类型字段类型字段含义字段含义1抄表接口数据标识DATA_IDNUMBER(15)本实体记录的唯一标识，产生规则为流水号。下装时填写2申请编号APP_NOVARCHAR2(16)流程实例的唯一标识，可自行编码。下装时填写3.3.2 XXX2 表/视图相关内容同表 13.3.3 XXX1 方法/函数功能说明功能说明提供客户的基本信息查询调用位置调用位置所在的包，直接调用存储过程或函数不用说明函数方法函数方法参数代码参数代码数据类型数据类型参数说明参数说明输入参数输入参数项目名称接口设计说明书杭州朗新信息科技有限公司 版权所有 20093参数代码参数代码数据类型数

6、据类型参数说明参数说明输出参数输出参数示例示例使用开发代码举例说明如何调用4页面集成接口没有此接口方式可以删除此目录4.1 对外提供序序号号功能说明功能说明页面调用路径页面调用路径入参入参出参出参备注备注1可说明调用的示例等24.2 外部调用序序号号功能说明功能说明页面调用路径页面调用路径入参入参出参出参备注备注1可说明提供方的相关信息25Tuxedo 接口没有此接口方式可删除此章节目录。5.1 接口功能 1如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。TUXDEO 服务的使用表格描述。5.1.1 接口子功能 1如果功能简单

7、，此级目录可以不要，使用 TUXDEO 服务表格描述。Comment xsw1: 增加项目名称 接口设计说明书4杭州朗新信息科技有限公司 版权所有 2009TUXDO 接口服务表格如下:服务名称服务名称说明服务的 CODE 和名称描述描述参数名称参数名称数据长度数据长度参数说明参数说明输入参数输入参数参数名称参数名称数据长度数据长度参数说明参数说明输出参数输出参数错误信息错误信息部署情况部署情况示例示例使用开发代码举例说明如何调用5.1.2 接口子功能 2结构示意如果功能简单，此级目录可以不要。6WebService 服务接口没有此接口方式可以删除此目录6.1 接口综述综述 WebServic

8、e 接口相关的技术，如简介认证、压缩、数据规约及需要描述的一些规定等，根据需要增加下级目录说明，下述目录为建议性质.6.1.1 WebService 概述本节可根据需要增删。Comment xsw2: 表格合并Comment xsw3: 表格合并Comment xsw4: 增加项目名称接口设计说明书杭州朗新信息科技有限公司 版权所有 200956.1.2 认证机制本节可根据需要增删。说明认证机制6.1.3 数据规约说明格式约定、DTD 等6.2 接口功能 1如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。Webservice

9、服务的使用表格描述。6.2.1 接口子功能 1如果功能简单，此级目录可以不要，使用 Webservice 服务表格描述。Webservice 接口服务表格如下:方法名称方法名称说明服务的 CODE 和名称描述描述发布路径发布路径参数代码参数代码参数名称参数名称数据类型数据类型参数说明参数说明输入参数输入参数参数代码参数代码参数名称参数名称数据类型数据类型参数说明参数说明输出参数输出参数错误信息错误信息部署情况部署情况示例示例使用开发代码举例说明如何调用项目名称 接口设计说明书6杭州朗新信息科技有限公司 版权所有 20097文件接口7.1 文件名称说明传输文件的名称规则及格式，如 MRDATA.

10、DBF7.2 文件格式定义根据需要，说明文件的列分割，行分割等条件，建议用表格方式。例如字段可以使用下列表格。序号序号字段中文名字段中文名字段英文名字段英文名字段类型字段类型字段含义字段含义1抄表接口数据标识DATA_IDNUMBER(15)本实体记录的唯一标识，产生规则为流水号。下装时填写2申请编号APP_NOVARCHAR2(16)流程实例的唯一标识，可自行编码。下装时填写7.3 传输方法说明定期传递， FTP 或者指定目录等，如果使用方法，则参照类似格式：功能说明功能说明向抄表机中传输文件调用位置调用位置例如 DLL/OCX 等文件的路径名称等,如 sendFileToHc.dll函数方

11、法函数方法Public String qryOwe(String szStringRequest) throws RemoteException, Uexception, Exception;参数代码参数代码/名称名称数据类型数据类型参数说明参数说明PORTchar通讯端口号，参见标准代码PORT_NOBAUDRATEchar通讯波特率，参见标准代码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，见标准代码