比较好的接口设计说明书模板.doc-资料库

chenyu1280-3276404-16359647284590993761.doc.pdf-第1页.png

第1页 / 共13页

chenyu1280-3276404-16359647284590993761.doc.pdf-第2页.png

第2页 / 共13页

chenyu1280-3276404-16359647284590993761.doc.pdf-第3页.png

第3页 / 共13页

chenyu1280-3276404-16359647284590993761.doc.pdf-第4页.png

第4页 / 共13页

chenyu1280-3276404-16359647284590993761.doc.pdf-第5页.png

第5页 / 共13页

chenyu1280-3276404-16359647284590993761.doc.pdf-第6页.png

第6页 / 共13页

chenyu1280-3276404-16359647284590993761.doc.pdf-第7页.png

第7页 / 共13页

chenyu1280-3276404-16359647284590993761.doc.pdf-第8页.png

第8页 / 共13页

<项目编号/项目名称> 接口设计说明书（版本号 VX.X） xxxxx 有限公司二〇XX 年 XX 月

版本号修改编号更改时间更改履历更改的图表和章节号更改简要描述更改人批准人注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。

项目名称接口设计说明书目录 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 xxxxx 有限公司版权所有 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 接口结构说明接口的系统、功能的分布关系，优先图示说明，如果需要，可以列出接口功能清单。 xxxxx 有限公司版权所有 2009 1

项目名称 2.3 数据流分析接口设计说明书为说明数据流向描述功能模块实现对应需求的数据流程图,说明数据经过处理后的输出传输情况。可选 3 中间库接口通常不建议使用此接口方式实现，没有此接口方式可以删除此目录. 3.1 中间库说明说明传输数据库版本等 3.2 传输交互方法说明数据交互的频率、主动、触发等方式。 3.3 中间库接口结构 3.3.1 XXX1 表/视图如果是表采用下表描述结构序号 1 2 字段中文名字段英文名字段类型字段含义抄表接口数据标识 DATA_ID NUMBER(15) 申请编号 APP_NO VARCHAR2(16) 本实体记录的唯一标识，产生规则为流水号。下装时填写流程实例的唯一标识，可自行编码。下装时填写 3.3.2 XXX2 表/视图相关内容同表 1 3.3.3 XXX1 方法/函数功能说明调用位置函数方法输入参数提供客户的基本信息查询所在的包，直接调用存储过程或函数不用说明参数代码数据类型参数说明 2 杭州朗新信息科技有限公司版权所有 2009

资料库

比较好的接口设计说明书模板.doc

相关推荐

信息化

热门标签

最新资料