软件工程过程资料-接口设计说明书
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
2.2
说明接口的系统、功能的分布关系，优先图示说明，如果需要，可以列出接口功能清单。
2.3
为说明数据流向描述功能模块实现对应需求的数据流程图,说明数据经过处理后的输出传输情况。可选
3
通常不建议使用此接口方式实现，没有此接口方式可以删除此目录.
3.1
说明传输数据库版本等
3.2
说明数据交互的频率、主动、触发等方式。
数据类型
参数说明
PORT
char
通讯端口号，参见标准代码PORT_NO
BAUDRATE
char
通讯波特率，参见标准代码BAUD_RATE
输出参数
参数代码/名称
数据类型
参数说明
示例
int SendFileToHc(char PORT,char BAUDRATE,char DATAFILE, char APPFILE, char PROMPT);
参数4：F4.mid的路径同F3.dwn的路径。
7.4
标题名称自定，例如可以约定目录结构、某某协议内容等，自行扩展。
8
约定的标准参数代码、返回代码等，自行扩展。
序号
字段中文名
字段英文名
字段类型
字段含义
1
抄表接口数据标识
DATA_ID
NUMBER(15)
本实体记录的唯一标识，产生规则为流水号。
下装时填写
2
申请编号
APP_NO
VARCHAR2(16)
流程实例的唯一标识，可自行编码。
下装时填写
7.3
说明定期传递，FTP或者指定目录等，如果使用方法，则参照类似格式：
功能说明
提供客户的基本信息查询
调用位置
所在的包，直接调用存储过程或函数不用说明
函数方法
输入参数
参数代码
数据类型
参数说明
输出参数
参数代码
数据类型
参数说明
示例
使用开发代码举例说明如何调用
4
没有此接口方式可以删除此目录
4.1
序号
功能说明
页面调用路径
入参
出参
备注
1
可说明调用的示例等
2
4.2
序号
功能说明
页面调用路径
服务名称
说明服务的CODE和名称
ห้องสมุดไป่ตู้描述
输入参数
参数名称
数据长度
参数说明
输出参数
参数名称
数据长度
参数说明
错误信息
部署情况
示例
使用开发代码举例说明如何调用
5.1.2
结构示意如果功能简单，此级目录可以不要。
6
没有此接口方式可以删除此目录
6.1
综述WebService接口相关的技术，如简介认证、压缩、数据规约及需要描述的一些规定等，根据需要增加下级目录说明，下述目录为建议性质.
<项目编号/项目名称>
接口设计说明书
（版本号VX.X）
更改履历
版本号
修改编号
更改时间
更改的
图表和章节号
更改简要描述
更改人
批准人
注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。
1
1.1
无相关图表的章节中，可自行根据需要加入图表说明，下同。
要达到的目的简述，例如说明需要支持的功能目标等。
1.2
文档的适用范围，比如是在全公司适用还是在某个产品部适用等。预期的读者是哪些等。
1.3
列出本文件中用到的专门术语的定义，例如中间库在本项目中的的含义，如果没有需特别要说明的，可删除此章节
术语
解释
1.4
列出有关的参考资料
2
2.1
【说明本模块的基本设计概念，比如对需求是如何考虑的，为什么要把对应的需求转换成这样的设计处理，以及接口的概况性的描述、要求】
功能说明
向抄表机中传输文件
调用位置
例如DLL/OCX等文件的路径名称等,如sendFileToHc.dll
函数方法
PublicStringqryOwe(String szStringRequest) throws RemoteException,Uexception,Exception;
输入参数
参数代码/名称
SendFileToHc(‘1’,‘05’,’C:\F1.DBF; F2.DBF’,‘C:\F3.dwn; F4.mid’,’1’);
注：参数1：’1’表述端口号为COM1，见标准代码PORT_NO
参数2：’05’表示波特率为115.2k，见标准代码BAUD_RATE
参数3：F2.DBF的路径同F1.DBF的路径。
6.1.1
本节可根据需要增删。
6.1.2
本节可根据需要增删。
说明认证机制
6.1.3
说明格式约定、DTD等
6.2
如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。Webservice服务的使用表格描述。
6.2.1
如果功能简单，此级目录可以不要，使用Webservice服务表格描述。
入参
出参
备注
1
可说明提供方的相关信息
2
5
没有此接口方式可删除此章节目录。
5.1
如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。TUXDEO服务的使用表格描述。
5.1.1
如果功能简单，此级目录可以不要，使用TUXDEO服务表格描述。
TUXDO接口服务表格如下:
3.3
3.3.1
如果是表采用下表描述结构
序号
字段中文名
字段英文名
字段类型
字段含义
1
抄表接口数据标识
DATA_ID
NUMBER(15)
本实体记录的唯一标识，产生规则为流水号。
下装时填写
2
申请编号
APP_NO
VARCHAR2(16)
流程实例的唯一标识，可自行编码。
下装时填写
3.3.2
相关内容同表1
3.3.3
Webservice接口服务表格如下:
方法名称
说明服务的CODE和名称
描述
发布路径
输入参数
参数代码
参数名称
数据类型
参数说明
输出参数
参数代码
参数名称
数据类型
参数说明
错误信息
部署情况
示例
使用开发代码举例说明如何调用
7
7.1
说明传输文件的名称规则及格式，如MRDATA.DBF
7.2
根据需要，说明文件的列分割，行分割等条件，建议用表格方式。例如字段可以使用下列表格。
说明接口的系统、功能的分布关系，优先图示说明，如果需要，可以列出接口功能清单。
2.3
为说明数据流向描述功能模块实现对应需求的数据流程图,说明数据经过处理后的输出传输情况。可选
3
通常不建议使用此接口方式实现，没有此接口方式可以删除此目录.
3.1
说明传输数据库版本等
3.2
说明数据交互的频率、主动、触发等方式。
数据类型
参数说明
PORT
char
通讯端口号，参见标准代码PORT_NO
BAUDRATE
char
通讯波特率，参见标准代码BAUD_RATE
输出参数
参数代码/名称
数据类型
参数说明
示例
int SendFileToHc(char PORT,char BAUDRATE,char DATAFILE, char APPFILE, char PROMPT);
参数4：F4.mid的路径同F3.dwn的路径。
7.4
标题名称自定，例如可以约定目录结构、某某协议内容等，自行扩展。
8
约定的标准参数代码、返回代码等，自行扩展。
序号
字段中文名
字段英文名
字段类型
字段含义
1
抄表接口数据标识
DATA_ID
NUMBER(15)
本实体记录的唯一标识，产生规则为流水号。
下装时填写
2
申请编号
APP_NO
VARCHAR2(16)
流程实例的唯一标识，可自行编码。
下装时填写
7.3
说明定期传递，FTP或者指定目录等，如果使用方法，则参照类似格式：
功能说明
提供客户的基本信息查询
调用位置
所在的包，直接调用存储过程或函数不用说明
函数方法
输入参数
参数代码
数据类型
参数说明
输出参数
参数代码
数据类型
参数说明
示例
使用开发代码举例说明如何调用
4
没有此接口方式可以删除此目录
4.1
序号
功能说明
页面调用路径
入参
出参
备注
1
可说明调用的示例等
2
4.2
序号
功能说明
页面调用路径
服务名称
说明服务的CODE和名称
ห้องสมุดไป่ตู้描述
输入参数
参数名称
数据长度
参数说明
输出参数
参数名称
数据长度
参数说明
错误信息
部署情况
示例
使用开发代码举例说明如何调用
5.1.2
结构示意如果功能简单，此级目录可以不要。
6
没有此接口方式可以删除此目录
6.1
综述WebService接口相关的技术，如简介认证、压缩、数据规约及需要描述的一些规定等，根据需要增加下级目录说明，下述目录为建议性质.
<项目编号/项目名称>
接口设计说明书
（版本号VX.X）
更改履历
版本号
修改编号
更改时间
更改的
图表和章节号
更改简要描述
更改人
批准人
注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。
1
1.1
无相关图表的章节中，可自行根据需要加入图表说明，下同。
要达到的目的简述，例如说明需要支持的功能目标等。
1.2
文档的适用范围，比如是在全公司适用还是在某个产品部适用等。预期的读者是哪些等。
1.3
列出本文件中用到的专门术语的定义，例如中间库在本项目中的的含义，如果没有需特别要说明的，可删除此章节
术语
解释
1.4
列出有关的参考资料
2
2.1
【说明本模块的基本设计概念，比如对需求是如何考虑的，为什么要把对应的需求转换成这样的设计处理，以及接口的概况性的描述、要求】
功能说明
向抄表机中传输文件
调用位置
例如DLL/OCX等文件的路径名称等,如sendFileToHc.dll
函数方法
PublicStringqryOwe(String szStringRequest) throws RemoteException,Uexception,Exception;
输入参数
参数代码/名称
SendFileToHc(‘1’,‘05’,’C:\F1.DBF; F2.DBF’,‘C:\F3.dwn; F4.mid’,’1’);
注：参数1：’1’表述端口号为COM1，见标准代码PORT_NO
参数2：’05’表示波特率为115.2k，见标准代码BAUD_RATE
参数3：F2.DBF的路径同F1.DBF的路径。
6.1.1
本节可根据需要增删。
6.1.2
本节可根据需要增删。
说明认证机制
6.1.3
说明格式约定、DTD等
6.2
如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。Webservice服务的使用表格描述。
6.2.1
如果功能简单，此级目录可以不要，使用Webservice服务表格描述。
入参
出参
备注
1
可说明提供方的相关信息
2
5
没有此接口方式可删除此章节目录。
5.1
如提供给银行的“查询电费”功能，一些需要说明的信息在此说明;如果功能比较复杂，可以根据需要设立下级子功能的目录结构。TUXDEO服务的使用表格描述。
5.1.1
如果功能简单，此级目录可以不要，使用TUXDEO服务表格描述。
TUXDO接口服务表格如下:
3.3
3.3.1
如果是表采用下表描述结构
序号
字段中文名
字段英文名
字段类型
字段含义
1
抄表接口数据标识
DATA_ID
NUMBER(15)
本实体记录的唯一标识，产生规则为流水号。
下装时填写
2
申请编号
APP_NO
VARCHAR2(16)
流程实例的唯一标识，可自行编码。
下装时填写
3.3.2
相关内容同表1
3.3.3
Webservice接口服务表格如下:
方法名称
说明服务的CODE和名称
描述
发布路径
输入参数
参数代码
参数名称
数据类型
参数说明
输出参数
参数代码
参数名称
数据类型
参数说明
错误信息
部署情况
示例
使用开发代码举例说明如何调用
7
7.1
说明传输文件的名称规则及格式，如MRDATA.DBF
7.2
根据需要，说明文件的列分割，行分割等条件，建议用表格方式。例如字段可以使用下列表格。