接口设计说明书模版

接口设计说明书

保密文件

不得外传

XXXXXXXXXXXXXXXXX有限公司接口设计说明书1/8

文档修订记录

*变化状态：建立，修改，增加，删除

文档审批信息

XXXXXXXXXXXXXXXXX有限公司接口设计说明书2/8

主要内容

1引言 (5)

1.1编写目的 (5)

1.2内容范围 (5)

1.3读者对象 (5)

1.4术语定义 (5)

1.5参考资料 (5)

2总体设计 (6)

2.1接口应用模型 (6)

2.2接口实现机制 (6)

2.3传输控制 (6)

2.4通信服务 (6)

2.5性能设计 (6)

2.6数据分析与校验 (6)

2.7数据压缩与解压 (6)

2.8数据交换分发 (6)

2.9作业优先级设计 (7)

2.10事务完整性 (7)

2.11异常处理机制 (7)

2.12人工干预 (7)

3接口应用部署 (7)

4功能模块设计一 (7)

4.1功能列表 (7)

4.2功能模块 (7)

4.2.1功能描述 (7)

XXXXXXXXXXXXXXXXX有限公司接口设计说明书3/8

4.2.2接口数据定义 (7)

4.2.3接口流程 (7)

4.2.4与其他模块关系 (7)

4.2.5性能 (7)

4.2.6异常机制 (7)

5功能模块设计二 (8)

6公共代码定义 (8)

XXXXXXXXXXXXXXXXX有限公司接口设计说明书4/8

1引言

1.1编写目的

[说明此文档的目的]

1.2内容范围

[说明此文档包含的内容范围]

1.3读者对象

[说明本文档的阅读对象]

1.4术语定义

[说明本文档使用的术语的定义]

1.5参考资料

[说明本文档的参考资料]

XXXXXXXXXXXXXXXXX有限公司接口设计说明书5/8

2总体设计

2.1接口应用模型

2.2接口实现机制

基于消息和基于事务。交互的模型或者数据的模型。

2.3传输控制

传输方式，根据数据量的大小。

2.4通信服务

通信方式等描述

2.5性能设计

负载均衡等。

2.6数据分析与校验

2.7数据压缩与解压

2.8数据交换分发

（调度）

XXXXXXXXXXXXXXXXX有限公司接口设计说明书6/8

2.9作业优先级设计

2.10事务完整性

2.11异常处理机制

2.12人工干预

3接口应用部署

4功能模块设计一

4.1功能列表

4.2功能模块

4.2.1功能描述

4.2.2接口数据定义

4.2.3接口流程

4.2.4与其他模块关系

4.2.5性能

4.2.6异常机制

XXXXXXXXXXXXXXXXX有限公司接口设计说明书7/8

5功能模块设计二

……

6公共代码定义

XXXXXXXXXXXXXXXXX有限公司接口设计说明书8/8