接口设计说明书模板

V项目编号/项目名称〉接口设计说明书（版本号VX.X）杭州朗新信息科技有限公司

二OXX年XX月更改履历版本号修改编号更改时间更改的图表和章节号更改简要描述更改人批准人注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。目录TOC\o"1-5"\h\z\o"CurrentDocument"1引言1\o"CurrentDocument"设计目标1\o"CurrentDocument"1.2适用范围1\o"CurrentDocument"1.3相关术语1\o"CurrentDocument"1.4参考资料1\o"CurrentDocument"2分析设计1\o"CurrentDocument"2.1设计思想1\o"CurrentDocument"2.2接口结构1\o"CurrentDocument"2.3数据流分析2\o"CurrentDocument"中间库接口2\o"CurrentDocument"3.1中间库说明2\o"CurrentDocument"3.2传输交互方法2\o"CurrentDocument"3.3中间库接口结构2XXXI表/视图2XXX2表/视图2XXXI方法/函数2\o"CurrentDocument"页面集成接口3\o"CurrentDocument"4.1对外提供3\o"CurrentDocument"4.2外部调用3\o"CurrentDocument"TUXEDO接口3\o"CurrentDocument"5.1接口功能135.1.1接口子功能135.1.2接口子功能24\o"CurrentDocument"WEBSERVICE服务接口4\o"CurrentDocument"6.1接口综述4WebService概述46.1.2认证机制56.13数据规约5\o"CurrentDocument"6.2接口功能156.2.1接口子功能15文件接口67.1文件名称6\o"CurrentDocument"7.2文件格式定义6\o"CurrentDocument"7.3传输方法6\o"CurrentDocument"7.4｛其他约定｝7\o"CurrentDocument"标准代码71引言1.1设计目标无相关图表的章节中，可自行根据需要加入图表说明，下同。要达到的目的简述，例如说明需要支持的功能目标等。1.2适用范围文档的适用范围，比如是在全公司适用还是在某个产品部适用等。预期的读者是哪些等。1.3相关术语列出本文件中用到的专门术语的定义，例如中间库在本项目中的的含义，如果没有需特别要说明的，可删除此章节术语[解释L4参考资料列出有关的参考资料2分析设计2.1设计思想【说明本模块的基本设计概念，比如对需求是如何考虑的，为什么要把对应的需求转换成这样的设计处理，以及接口的概况性的描述、要求】2.2接口结构说明接口的系统、功能的分布关系，优先图示说明，如果需要，可以列出接口功能清单。2.3数据流分析为说明数据流向描述功能模块实现对应需求的数据流程图，说明数据经过处理后的输出传输情况。可选3中间库接口王常不建议使用此接口方式实现，没有此接口方式可以删除此目录.3.1中间库说明说明传输数据库版本等3.2传输交互方法说明数据交互的频率、主动、触发等方式。3.3中间库接口结构XXXI表/视图如果是表采用下表描述结构序号字段中文名字段英文名字段类型字段含义1抄表接II数据标识DATA_IDNUMBER。5)本实体记录的唯一标识，产生规则为流水号。下装时填写2申请编号APP.NO\ARCHAR2(16)流程实例的唯一标识，可自行编码。下装时填写XXX2表/视图相关内容同表1XXXI方法/函数功能说明提供客户的基本信息查询调用位置所在的包，直接调用存储过程或函数不用说明函数方法输入参数参数代码数据类型参数说明输出参数参数代码数据类型参数说明示例使用开发代码举例说明如何调用4页面集成接口没有此接11方式可以删除此目录4.1对外提供序号功能说明页面调用路径入参出参备注1可说明调用的示例等24.2外部调用序号功能说明页面调用路径入参出参备注1可说明提供方的相关信息25Tuxedo接口没有此接口方式可删除此章节目录。5.1接口功能1如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。TUXDEO服务的使用表格描述。5.1.1接口子功能1如果功能简单，此级目录可以不要，使用TUXDEO服务表格描述。

TUXDO接口服务表格如下:服务名称说明服务的CODE和名称描述输入参数参数名称数据长度参数说明输出参数参数名称数据长度参数说明错误信息部署情况示例使用开发代码举例说明如何调用5.1.2接口子功能2结构示意如果功能简单，此级目录可以不要。6WebSeivice服务接口没有此接11方式可以删除此目录6.1接口综述综述WebSeivice接口相关的技术，如简介认证、压缩、数据规约及需要描述的一些规定等，根据需要增加下级目录说明，下述目录为建议性质.6.1.1WebSeivice概述本节可根据需要增删。6.1.2认证机制本节可根据需要增删。说明认证机制6.1.3数据规约说明格式约定、DTD等6.2接口功能1如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。Websemce服务的使用表格描述。6.2.1接口子功能1如果功能简单，此级目录可以不要，使用Webseivice服务表格描述。Webseivice接口服务表格如下：方法名称说明服务的CODE和名称描述发布路径输入参数参数代码参数名称数据类型参数说明输出参数参数代码参数名称数据类型参数说明错误信息部署情况示例使用开发代码举例说明如何调用

7文件接口7.1文件名称说明传输文件的名称规则及格式，如MRDATA.DBF7.2文件格式定义根据需要，说明文件的列分割，行分割等条件，建议用表格方式。例如字段可以使用下列表格。序号字段中文名字段英文名字段类型字段含义1抄表接「1数据标识DATA.IDNUMBER(15)本实体记录的唯一标识，产生规则为流水号。下装时填写2申请编号APP_NO\ARCHAR2(16)流程实例的唯一标识，可自行编码。下装时填写7.3传输方法说明定期传递，FTP或者指定目录等，如果使用方法，则参照类似格式:功能说明向抄表机中传输文件调用位置例如DLL/OCX等文件的路径名称等，如sendFileToHc.dll函数方法PublicStimgqiyOwe(StiingszStnngRequest)tluowsRemoteException,Uexception.Exception;输入参数参数代码/名称数据类型参数说明PORTchai通讯端11号，参见标准代码PORT_.NOBAUDRATEchai通讯波特率，参见标准代码BAUD_RATE输出参数参数代码/名称数据类型参数说明示例intSendFileToHc(charPORT,charBAUDRATE.charDATAFILE,charAPPFILE,charPROMPT);SendFileToHc(4\‘05’,‘C:\F1.DBF;F2.DBF\X:\F3.d