接口设计说明书模板(new).doc

<项目编号/项目名称>

接口设计说明书

（版本号VX.X）

杭州朗新信息科技有限公司

二〇XX年XX月

更改履历

版本号

修改编号

更改时间

更改的

图表和章节号

更改简要描述

更改人

批准人

注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。

项目名称接口设计说明书

项目名称 接口设计说明书

PAGE6 杭州朗新信息科技有限公司版权所有2009

杭州朗新信息科技有限公司版权所有2009 PAGE5

业务模型说明书第二篇抄表管理分册

国家电网公司版权所有2007PAGEI

目录

TOC\o"1-4"\h\z1 引言 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

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.1 文件名称 6

7.2 文件格式定义 6

7.3 传输方法 6

7.4 {其他约定} 7

8 标准代码 7

引言

设计目标

无相关图表的章节中，可自行根据需要加入图表说明，下同。

要达到的目的简述，例如说明需要支持的功能目标等。

适用范围

文档的适用范围，比如是在全公司适用还是在某个产品部适用等。预期的读者是哪些等。

相关术语

列出本文件中用到的专门术语的定义，例如中间库在本项目中的的含义，如果没有需特别要说明的，可删除此章节

术语

解释

参考资料

列出有关的参考资料

分析设计

设计思想

【说明本模块的基本设计概念，比如对需求是如何考虑的，为什么要把对应的需求转换成这样的设计处理，以及接口的概况性的描述、要求】

接口结构

说明接口的系统、功能的分布关系，优先图示说明，如果需要，可以列出接口功能清单。

数据流分析

为说明数据流向描述功能模块实现对应需求的数据流程图,说明数据经过处理后的输出传输情况。可选

中间库接口

通常不建议使用此接口方式实现，没有此接口方式可以删除此目录.

中间库说明

说明传输数据库版本等

传输交互方法

说明数据交互的频率、主动、触发等方式。

中间库接口结构

XXX1表/视图

如果是表采用下表描述结构

序号

字段中文名

字段英文名

字段类型

字段含义

1

抄表接口数据标识

DATA_ID

NUMBER(15)

本实体记录的唯一标识，产生规则为流水号。

下装时填写

2

申请编号

APP_NO

VARCHAR2(16)

流程实例的唯一标识，可自行编码。

下装时填写

XXX2表/视图

相关内容同表1

XXX1方法/函数

功能说明

提供客户的基本信息查询

调用位置

所在的包，直接调用存储过程或函数不用说明

函数方法

输入参数

参数代码

数据类型

参数说明

输出参数

参数代码

数据类型

参数说明

示例

使用开发代码举例说明如何调用

页面集成接口

没有此接口方式可以删除此目录

对外提供

序号

功能说明

页面调用路径

入参

出参

备注

1

可说明调用的示例等

2

外部调用

序号

功能说明

页面调用路径

入参

出参

备注

1

可说明提供方的相关信息

2

Tuxedo接口

没有此接口方式可删除此章节目录。

接口功能1

如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。TUXDEO服务的使用表格描述。

接口子功能1

如果功能简单，此级目录可以不要，使用TUXDEO服务表格描述。

TUXDO接口服务表格如下:

服