《接口设计说明书模板(new)》由会员分享，可在线阅读，更多相关《接口设计说明书模板(new)（13页珍藏版）》请在金锄头文库上搜索。
1、 接口设计说明书接口设计说明书 （版本号 VX.X） 杭州朗新信息科技有限公司杭州朗新信息科技有限公司 二二XXXX 年年 XXXX 月月 更改履历 版本号版本号修改编号修改编号更改时间更改时间 更改的更改的 图表和章节号图表和章节号 更改简要描述更改简要描述更改人更改人批准人批准人 注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式 进行修改。 目 录 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、.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 5TUXEDO 接口接口.3 5.1接口功能 1.3 5.1.1 接口子功能 1.3 5.1.2 接口子功能 2.4 6WEBSERVICE 服务接口服务接口.4 6.1接口综述.4 6.1.1 WebService 概述.4 6.1.2 认证机制.4 6.1.3 数据规约.5 6.2接口功能 1.5 6.2.1 接口子功能 1.5 7文件接口文件接口.6 7
3、.1文件名称.6 7.2文件格式定义.6 7.3传输方法.6 7.4其他约定.7 8标准代码标准代码.7 1引言 1.1 设计目标 无相关图表的章节中，可自行根据需要加入图表说明，下同。 要达到的目的简述，例如说明需要支持的功能目标等。 1.2 适用范围 文档的适用范围，比如是在全公司适用还是在某个产品部适用等。预期的读 者是哪些等。 1.3 相关术语 列出本文件中用到的专门术语的定义，例如中间库在本项目中的的含义，如 果没有需特别要说明的，可删除此章节 术语术语解释解释 1.4 参考资料 列出有关的参考资料 2分析设计 2.1 设计思想 【说明本模块的基本设计概念，比如对需求是如何考虑的，为什么要把对应的需求转换成这 样的设计处理，以及接口的概况性的描述、要求】 2.2 接口结构 说明接口的系统、功能的分布关系，优先图示说明，如果需要，可以列出接 口功能清单。 2.3 数据流分析 为说明数据流向描述功能模块实现对应需求的数据流程图,说明数据经过处理 后的输出传输情况。可选 3中间库接口 通常不建议使用此接口方式实现，没有此接口方式可以删除此目录. 3.1 中间库说明 说明传输数据库版本等 3.2 传输交互方法 说明数据交互的频率、主动、触发等方式。 3.3 中间库接口结构 3.3.1 XXX1 表/视图 如果是表采用下表描述结构 序序 号
