HRHIP接口设计说明(IDD)模板
XXX系统(HRHIP)V1.0
(IDD)
接口设计说明
上海融达信息科技有限公司
All rights reserved
版权所有侵权必究
RD-RHIP 接口设计说明（IDD ） 密级：秘密
上海融达信息科技有限公司 － 2 / 7 －
修订记录
RD-RHIP 接口设计说明（IDD ） 密级：秘密
上海融达信息科技有限公司 － 3 / 7 －
目录
1引言 ........................................................................................................................................................................... 4 1.1. 标识 ..................................................................................................................................................................... 4 1.2. 系统概述 .............................................................................................................................................................. 4 1.3. 文档概述 .............................................................................................................................................................. 4 1.4. 基线 (4)
2. 引用文件 ······························································································································································ 4
3.
接口设计 ······························································································································································ 4 3.1.
接口标识和接口图 (4)
4. X(接口的项目唯一标识符) ··································································································································· 5
5. 需求的可追踪性 ·················································································································································· 6
6.
注解······································································································································································ 6 6.1.
文档中使用的缩略语清单 (6)
附录 (7)
RD-RHIP 接口设计说明（IDD ） 密级：秘密
上海融达信息科技有限公司 － 4 / 7 －
1. 引言
1.1标识
本条应包含本文档适用的系统、接口实体和接口的完整标识，(若适用)包括标识号、标题、缩略词语、版本号、发行号。
1.2系统概述
本条应简述本文档适用的系统和软件的用途。它应描述系统与软件的一般性质；概述系统开发、运行和维护的历史；标识项目的投资方、需方、用户、开发方和支持机构；标识当前和计划的运行现场；并列出其他有关文档。
1.3文档概述
本条应概括本文档的用途与内容，并描述与其使用有关的保密性或私密性要求。
1.4基线
说明编写本系统设计说明书所依据的设计基线。
2. 引用文件
本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。本章也应标识不能通过正常的供货渠道获得的所有文档的来源。
3. 接口设计
本章应分条描述一个或多个系统、子系统、配置项、手工操作和其他系统部件的接口特性。如果设计的部分或全部依赖于系统状态或方式，则应指出这种依赖性。如果设计信息在多条中出现，则可只描述一次，而在其他条加以引用。如果此信息的部分或全部在别处提供，则此处可以引用。应给出或引用为了理解设计所需的设计约定。
3.1接口标识和接口图
对于1.1中所标识的每个接口，本条应陈述赋予该接口的项目唯一标识符，(若适用)并用
RD-RHIP 接口设计说明（IDD ） 密级：秘密
上海融达信息科技有限公司 － 5 / 7 －
名字、编号、版本和文档引用等标识接口实体(系统、配置项、用户等)。该标识应说明哪些实体具有固定的接口特性(因而要对这些接口实体强加接口需求)，哪些实体正被开发或修改(从而已将接口需求施加于它们)。(若适用)可用一个或多个接口图来描述这些接口。
4. x(接口的项目唯一标识符)
本条(从3.2开始编号)应通过项目唯一标识符标识接口，应简要标识接口实体，并且应根据需要划分为几条描述接口实体的单方或双方的接口特性。如果一给定的接口实体本文没有提及(例如，一个外部系统)，但是其接口特性需要在本文描述的接口实体时提到，则这些特性应以假设、或“当[未提到实体]这样做时，[被提到的实体]将……”的形式描述。本条可引用其他文档(例如数据字典、协议标准、用户接口标准)代替本条的描述信息。(若适用)本设计说明应包括以下内容，它们可按适合于要提供的信息的任何次序给出，并且应从接口实体角度指出这些特性之间的区别(例如数据元素的大小、频率或其他特性的不同期望)。
a.接口实体分配给接口的优先级别；
b.要实现的接口的类型(如：实时数据传送、数据的存储和检索等)；
c.接口实体必须提供、存储、发送、访问、接收的单个数据元素的特性，如： 1)名称/标识符； a)项目唯一标识符；
b)非技术(自然语言)名称； c)标准数据元素名称；
d)技术名称(如代码或数据库中的变量或字段名称)； e)缩写名或同义名；
2)数据类型(字母数字、整数等)；
3)大小和格式(如：字符串的长度和标点符号)； 4)计量单位(如：米、元、纳秒)； 5)范围或可能值的枚举(如：0-99)；
6)准确度(正确程度)和精度(有效数字位数)；
7)优先级别、时序、频率、容量、序列和其他的约束条件，如：数据元素是否可被更新和业务规则是否适用；
8)保密性和私密性的约束；
9)来源(设置/发送实体)和接收者(使用/接收实体)；
d.接口实体必须提供、存储、发送、访问和接收的数据元素集合体(记录、消息、文件、显示和报表等)的特性，如：
1)名称/标识符； a)项目唯一标识符；
b)非技术(自然语言)名称；
c)技术名称(如代码或数据库的记录或数据结构)； d)缩写名或同义名；
2)数据元素集合体中的数据元素及其结构(编号、次序和分组)； 3)媒体(如盘)和媒体中数据元素/数据元素集合体的结构；
4)显示和其他输出的视听特性(如：颜色、布局、字体、图标和其他显示元素、蜂鸣声、亮度等)；
5)数据元素集合体之间的关系，如排序/访问特性；
RD-RHIP 接口设计说明（IDD ） 密级：秘密
上海融达信息科技有限公司 － 6 / 7 －
6)优先级别、时序、频率、容量、序列和其他的约束条件，如：数据元素集合体是否可被修改、业务规则是否适用；
7)保密性和私密性约束；
8)来源(设置/发送实体)和接收者(使用/接收实体)； e.接口实体必须为接口使用通信方法的特性。如： 1)项目唯一标识符；
2)通信链接/带宽/频率/媒体及其特性； 3)消息格式化；
4)流控制(如：序列编号和缓冲区分配)；
5)数据传送速率，周期性/非周期性，传输间隔； 6)路由、寻址、命名约定；
7)传输服务，包括优先级别和等级；
8)安全性/保密性/私密性方面的考虑，如：加密、用户鉴别、隔离和审核等； f.接口实体必须为接口使用协议的特性，如： 1)项目唯一标识符；
2)协议的优先级别/层次；
3)分组，包括分段和重组、路由、寻址； 4)合法性检查、错误控制和恢复过程； 5)同步，包括连接的建立、维护、终止； 6)状态、标识、任何其他的报告特征；
g.其他所需的特性，如：接口实体的物理兼容性(尺寸、容限、负荷、电压和接插件兼容性等)。
5. 需求的可追踪性
本章应包括：
a.从本文提到的每个接口实体到该实体的接口设计所涉及的系统或CSCI 需求的可追踪性；
b.从影响本IDD 所覆盖的接口的每个系统或CSCI 需求到涉及它的接口实体的可追踪性。
6. 注解
本章应包含有助于理解本文档的一般信息(例如背景信息、词汇表、原理)。本章应包含为理解本文档需要的术语和定义，所有缩略语和它们在文档中的含义的字母序列表。
6.1文档中使用的缩略语清单
上海融达信息科技有限公司 － 7 / 7 －
附录
附录可用来提供那些为便于文档维护而单独出版的信息(例如图表、分类数据)。为便于处理，附录可单独装订成册。附录应按字母顺序(A,B 等)编排。
(完整版)软件详细设计说明书模板
软件详细设计说明书 v1.0 200X年月XX日 修订历史记录
编制 审查 审核 批准 文档评审负责人：参加评审人员：
目录 1引言 (4) 1.1编写目的 (4) 1.2背景 (4) 1.3定义 (4) 1.4设计依据 (4) 2软件系统结构 (4) 2.1功能需求 (4) 2.2子模块划分 (4) 2.3子模块间关系 (4) 3公共数据结构 (4) 4程序设计说明 (5) 4.1程序1设计说明 (5) 4.1.1程序描述 (5) 4.1.2功能 (5) 4.1.3性能 (5) 4.1.4输入 (5) 4.1.5输出 (5) 4.1.6算法 (5) 4.1.7流程 (5) 4.2程序2设计说明 (5) 5模块重用说明 (5)
1引言 1.1编写目的 〖说明编写这份软件详细设计说明书的目的〗 1.2背景 〖说明待开发软件（子）系统的名称和此软件（子）系统所属大系统的名称； 说明任务的来源（开发背景和市场背景）等；该软件（子）系统与大系统中其他子系统的关系。〗 1.3定义 〖列出本文档中所用到的专门术语的定义和缩写词的原意〗 1.4设计依据 〖列出本文档所引用的有关设计依据（标题、文件编号、版本号、作者、发布日期、出版单位），包括本项目内部已编写的有效文档、出版刊物和国家标准或规范〗2软件系统结构 2.1功能需求 2.2子模块划分 〖说明本软件系统(或模块)的实现，即其内部的子模块划分（给出程序的名称和标识符）。建议以图形说明。〗 1.XXXXXXXX 2.XXXXXXXX 3.XXXXXXXX 4.XXXXXXXX 5.XXXXXXXX 6.XXXXXXXX 2.3子模块间关系 〖说明各子模块间的控制、顺序等耦合关系。〗 3公共数据结构 〖给出本软件系统使用的每一个公共数据结构的类型定义、存储方式，公共数据结构内各元素项的类型定义、初始取值、可能取值的范围及相应的物理含义。建议以类似Ｃ语言的数据说明格式来描述。〗
API接口文档
API接口文档 最后更新日期：2013-05-16 一、添加域名接口 (6) 1、接口调用地址 (6) 2、传入参数 (6) 3、输出数据 (6) 二、删除域名接口 (7) 1、接口调用地址 (7) 2、传入参数 (7) 3、输出数据 (7) 三、添加用户接口 (8) 1、接口调用地址 (8) 2、传入参数 (8) 3、输出数据 (8) 四、获取用户信息接口 (9) 1、接口调用地址 (9) 2、传入参数 (9) 3、输出数据 (9) 五、搜索用户接口 (10) 1、接口调用地址 (10) 2、传入参数 (10) 3、输出数据 (10) 六、修改用户接口 (11) 1、接口调用地址 (11) 2、传入参数 (11) 3、输出数据 (12) 七、删除用户接口 (13) 1、接口调用地址 (13) 2、传入参数 (13) 3、输出数据 (13) 八、获取邮箱别名接口 (14) 1、接口调用地址 (14) 2、传入参数 (14) 3、输出数据 (14) 九、获取部门列表接口 (15) 1、接口调用地址 (15) 2、传入参数 (15) 3、输出数据 (15) 十、添加部门接口 (17) 1、接口调用地址 (17)
3、输出数据 (17) 十一、修改部门接口 (18) 1、接口调用地址 (18) 2、传入参数 (18) 3、输出数据 (18) 十二、删除部门接口 (19) 1、接口调用地址 (19) 2、传入参数 (19) 3、输出数据 (19) 十三、获取部门成员接口 (20) 1、接口调用地址 (20) 2、传入参数 (20) 3、输出数据 (20) 十四、添加部门成员接口 (21) 1、接口调用地址 (21) 2、传入参数 (21) 3、输出数据 (21) 十五、删除部门成员接口 (22) 1、接口调用地址 (22) 2、传入参数 (22) 3、输出数据 (22) 十六、添加别名接口 (23) 1、接口调用地址 (23) 2、传入参数 (23) 3、输出数据 (23) 十七、修改别名接口 (24) 1、接口调用地址 (24) 2、传入参数 (24) 3、输出数据 (24) 十八、删除别名接口 (25) 1、接口调用地址 (25) 2、传入参数 (25) 3、输出数据 (25) 十九、获取POP接收邮件接口 (26) 1、接口调用地址 (26) 2、传入参数 (26) 3、输出数据 (26) 二十、添加POP接收邮件接口 (27) 1、接口调用地址 (27) 2、传入参数 (27) 3、输出数据 (27) 二十一、修改POP接收邮件接口 (28) 1、接口调用地址 (28)
接口设计规范
目录 1接口类型 (2) 1.1人机接口 (2) 1.2软件-硬件接口 (2) 1.3软件接口 (2) 1.4通信接口 (2) 2接口设计规范 (2) 2.1基本内容 (2) 2.2规格说明 (3) 2.2.1人机接口 (3) 2.2.2软件-硬件接口 (3) 2.2.3软件接口 (3) 2.2.4通信接口 (3) 3接口设计文档提纲 (3)
1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。 2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义 5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求
9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。 2.2.4通信接口 逐个描述各个通信接口的设计特性。包括硬件描述、接口功能说明、通信协议、报文处理、存储资源分配、程序接口设计和程序编制要求等。 3接口设计文档提纲 1概述........................................................................................................................................................... 错误！未定义书签。 1.1编写目的......................................................................................................................................... 错误！未定义书签。 1.2参考资料......................................................................................................................................... 错误！未定义书签。 1.3术语和缩写词................................................................................................................................ 错误！未定义书签。2软件系统综述......................................................................................................................................... 错误！未定义书签。3接口设计.................................................................................................................................................. 错误！未定义书签。 3.1接口框图......................................................................................................................................... 错误！未定义书签。 3.2接口一览表.................................................................................................................................... 错误！未定义书签。 3.3人机接口......................................................................................................................................... 错误！未定义书签。 3.4软件-硬件接口 .............................................................................................................................. 错误！未定义书签。
项目开发详细设计说明书(超好用模板)完整版
修订记录
目录 第一章概述........................................................................... 错误!未定义书签。 1.1.应用模块的目的....................................................... 错误!未定义书签。 1.2.应用模块总体描述................................................... 错误!未定义书签。 1.3.应用模块接口描述................................................... 错误!未定义书签。 1.4.假设条件................................................................... 错误!未定义书签。第二章设计模式（Design pattern） ................................... 错误!未定义书签。第三章类设计....................................................................... 错误!未定义书签。 3.1.分块类图................................................................... 错误!未定义书签。 <类图1> ............................................................ 错误!未定义书签。 <类图n> ............................................................ 错误!未定义书签。 3.2.整体继承关系........................................................... 错误!未定义书签。 3.3.类描述....................................................................... 错误!未定义书签。 <类名1> Class Description............................. 错误!未定义书签。 <类名n> Class Description............................. 错误!未定义书签。第四章交互图....................................................................... 错误!未定义书签。 4.1.<情景编号1: 情景名称> ........................................ 错误!未定义书签。 交互图................................................................ 错误!未定义书签。 例外情况及条件................................................ 错误!未定义书签。 4.2.<情景编号n: 情景名称> ........................................ 错误!未定义书签。第五章状态图....................................................................... 错误!未定义书签。 5.1.<状态图编号1:状态图名称> .................................. 错误!未定义书签。 5.2.<状态图编号n:状态图名称> .................................. 错误!未定义书签。第六章时序流程图............................................................... 错误!未定义书签。第七章用户界面设计说明................................................... 错误!未定义书签。 7.1.用户界面关系........................................................... 错误!未定义书签。 7.2.用户界面具体描述................................................... 错误!未定义书签。 <界面编号1:界面名称〉 ................................. 错误!未定义书签。 <界面编号N:界面名称〉 ................................ 错误!未定义书签。
软件系统详细设计说明书模板
xxxxx系统详细设计说明书
版本历史
修改记录
目录 1引言 (5) 1.1编写目的 (5) 1.2背景 (5) 1.3参考资料 (5) 1.4术语定义及说明 (5) 2设计概述 (5) 2.1任务和目标 (5) 2.1.1需求概述 (5) 2.1.2运行环境概述 (5) 2.1.3条件与限制 (6) 2.1.4详细设计方法和工具 (6) 3系统详细需求分析 (6) 3.1详细需求分析 (6) 3.2详细系统运行环境及限制条件分析接口需求分析 (6) 4总体方案确认 (6) 4.1系统总体结构确认 (6) 4.2系统详细界面划分 (7) 4.2.1应用系统与支撑系统的详细界面划分 (7) 4.2.2系统内部详细界面划分 (7) 5系统详细设计 (7) 5.1系统程序代码架构设计 (7) 5.1.1UI(User Interface)用户界面表示层 (7) 5.1.2BLL(Business Logic Layer)业务逻辑层 (8) 5.1.3DAL(Data Access Layer)数据访问层 (8) 5.1.4Common类库 (8) 5.1.5Entity Class实体类 (8) 5.2系统结构设计及子系统划分 (8) 5.3系统功能模块详细设计 (9) 5.3.1XX子系统 (9) .1XX模块 (9) 列表和分页 (9) 创建XX (9) .2XX模块 (9) XX列表 (9) XX修改 (9) 5.3.2XX子系统 (9) 5.3.6.1用户管理模块 (9) 5.3.6.2角色管理模块 (14) 5.3.6.3系统设置模块 (14) 5.3.6.4系统登录注销模块 (14) 5.4系统界面详细设计 (14) 5.4.1外部界面设计 (14) 5.4.2内部界面设计 (14) 5.4.3用户界面设计 (14) 6数据库系统设计 (14) 6.1设计要求 (14) 6.2信息模型设计 (14) 6.3数据库设计 (14) 6.3.1设计依据 (14)
开发接口文档-API文档模板
XXX项目接口文档版本控制信息 获取所有字段 获取所有字段 请求地址：/session/field/findAll 请求参数 响应
请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"ico nStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconSty le":"","id":7,"name":"XX"}]},"totals":0} 文件上传 文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：var formData = new FormData(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData,
processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功！'); $("#editHeadPortrait").val } } }); 响应例子：returnValue里包含了 fileName和filePath 字段管理-所属类型 新增所属类型 请求地址：/session/fieldType/save 请求参数 响应 请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}
详细设计说明书模版
（项目名称）详细设计说明书 文件版本 编写日期 发布日期
文件修改记录 修改日期版本号变化状态修改内容修改人 *变化状态：C――创建，A——增加，M——修改，D——删除 文档审批信息 版本号提交人批准人批准日期发布日期备注
目录 1引言 (1) 1.1编写目的 (1) 1.2适用范围 (1) 1.3术语和缩写 (1) 1.4参考资料 (1) 2概述 (1) 2.1系统概述 (1) 2.2系统功能定义 (1) 3总体结构说明 (1) 3.1系统结构 (1) 3.1.1系统内外部关系图 (1) 3.1.2功能模块简要说明 (1) 3.1.3依赖的外部接口 (1) 3.1.4对外提供的接口 (1) 3.2模块程序构件结构图 (1) 4数据模型（Data Model）设计 (2) 4.1逻辑实体模型 (2) 4.1.1实体模型1 (2) 4.1.2实体模型2 (3) 4.2表结构（物理设计） (3) 4.2.1表汇总 (3) 4.2.2表1 (3) 4.2.3表2 (3) 4.3视图列表 (4) 5功能实现说明 (4) 5.1数据流类模块 (4) 5.1.1数据流程图 (4) 5.1.2实现说明 (4) 5.1.3程序设计 (4) 5.2业务处理类模块 (5) 5.2.1Object Model设计 (5)
5.2.2程序设计 (5) 6界面实现说明 (5) 6.1模块1 (5) 6.1.1总体界面结构（业务操作区）说明 (5) 6.1.2功能点1界面结构说明 (5) 6.1.3功能点2界面结构说明 (5) 6.2模块2 (6) 6.2.1总体界面结构（业务操作区）说明 (6) 6.2.2功能点1界面结构说明 (6) 6.2.3功能点2界面结构说明 (6)
接口设计模板
<系统名称>接口设计说明书 ****科技有限公司
修改历史
目录 1概述 (1) 2子系统说明1 (1) 2.1接口名NO.1 (1) 2.2接口名NO.2 (1)
1概述 [概述说明本文档的描述的内容、目的、使用场合等。] 2子系统说明1 2.1接口名NO.1 示例如下： 接口功能： 验证用户是否合法。 除部分特别说明不需要用户验证的接口外，此接口必须首先调用，否则会出现“未授权”的异常错误。在验证成功之后才能成功调用其它接口，该接口验证通过的用户信息将保存到IHDUserSession类的实例中，作为其它接口调用的用户信息。 此接口在内部需要通过以下几点的验证： 1.CA验证，验证USBKey是否合法（只有系统策略中设置了需要CA验证选项后才 会进行CA的验证）； 2.域用户验证，验证登录用户名和密码是否是域用户，通过Windows集成身份验证 实现； 3.用户数据库合法性验证，验证登录用户是否存在于USERS表中； 4.计算机合法性验证，验证登录计算机是否存在于COMPUTER表中，计算机的验证 通过计算机名，硬盘序列号，网卡物理地址，IP地址这四项的组合进行验证，具 体组合可以系统策略中配置； 5.如果验证未通过，返回false，并在客户端日志中记录登录失败的原因 接口声明： *** 相关数据表： **** 输入参数： **** 输出参数： *** 返回值及异常： 参见错误！未找到引用源。错误！未找到引用源。 返回值不变。 捕获到异常，请对异常进行分析。如果异常类型是***。 2.2接口名NO.2
接口功能： 接口声明： 相关数据表：输入参数： 输出参数： 返回值及异常：
API 接口 设计文档 模板
Dream调试工具DLL接口文档 文件状态：[√] 草稿[ ] 正式发布[ ] 正在修改当前版本： 1.0 作者：ChunFeng Li 文件密级：[ ]普通[√]秘密[ ]绝密 文档版本 版本/状态作者参与者日期说明 1.0 ChunFeng Li ChunFeng Li 2016-04-13 设备只能发现串口连接的设备，指 令只能下发单条修改 一、DLL初始化 1.描述 调用所有接口之前需要先调用初始化接口。 2.接口名（dll导出名） Dream_Init() 3.请求参数说明 参数字段必选类型限制说明 _net_point True int<65535 Udp广播端口号 _com_rate True int 38400 连接串口的默认波特率 _call_back True Void* ... 异步消息回调（详细见第五条：回调函数） 4.返回参数说明 a.返回类型Int :0成功-1重复初始化 二、获取最新设备列表 1.描述 调用该接口获取所有当前在线列表。 2.接口名（dll导出名） Dream_GetDeviceList() 3.请求参数说明
char_buf True char* 1024 存放返回数据的内存指针，空间大小有调 用方分配 buf_len True int 1024 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。 b.返回数据结构:”1000,COM3\r\n1001,COM5\r\n1002,192.168.0.118\r\n”。 [ID,Name\r\n]为一个设备，以后有跟多设备详细信息，往后接。 三、发送指令消息 1.描述 下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明 参数字段必选类型限制说明 device_id True int>1000 发送消息的设备ID例如1000 _ChannelCode True int 0-0xFF 通道编码：例如0x10 _FunctionCode True int 0-0xFF 功能编码，不同的编码对应不同的功能_FunctionNumber True int 0-0xFF 功能编号，标记当前编码对应不同的功能data_msg True char* 发送指令的data，没有数据为NULL，如 果是单个数据：12.1，如果是整组数据： 12.1,1,0,...... 按顺序逗号隔开的连续字符 time_out True int 20*N 接口调用超时时间，单位毫秒 out_buf True char* 存放返回数据的内存指针，空间大小有调 用方分配 buf_max_len True int 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。如果为0,表示超时或网络异常 b.返回的数据结构：如果是下发数据，返回的是成功和失 败；”ACK”,”NAK”,”NO_CMD”,”ERROR”,”TimeOut”,如果是读取数据，返回的是数据， 例如12.1，或数据组12.1,12.2,1,1.2..... 四、DLL初始化 1.描述 下发数据和读取数据指令都通过该接口实现。(非阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明
详细设计说明书模板
修订历史记录 【模板使用必读：模板内容和页眉中【】包含内容为指导性的待替换文字，请在使用中替换为具体内容，或删除。文件提交时不得再含有这些内容。】
目录 1引言 (4) 1.1编写目的 (4) 1.2背景 (4) 1.3术语与缩写解释 (4) 1.4参考资料 (4) 2模块命名规则 (4) 3程序系统的组织结构 (5) 3.1子系统划分 (5) 3.2模块划分 (5) 3.3程序与功能需求、系统模块间的关系 (5) 4程序1（标识符）设计说明 (5) 4.1程序描述 (5) 4.2功能 (6) 4.3性能 (6) 4.4输人项 (6) 4.5输出项 (6) 4.6算法 (6) 4.7流程逻辑 (6) 4.8接口 (6) 4.9存储分配 (7) 4.10注释设计 (7) 4.11限制条件 (7) 4.12尚未解决的问题 (7) 5程序2（标识符）设计说明 (7)
引言 编写目的 【给出项目详细设计说明书的编写目的，同时指明读者对象。】 背景 【说明： a．待开发软件系统的名称； b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。】 术语与缩写解释 【列出本文件中用到的专门术语的定义和外文首字母缩写的原词组。】 参考资料 【提示：可包括：（1）本项目经核准的计划任务书、需求规格说明书、合同、项目设计概要说明书或上级机关的批文；（2）本文档所引用的资料、规范等，列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。】
模块命名规则 【确定本软件的模块命名规则，例如类、函数、变量等，确保设计文档的风格保持一致。可以从机构的编码规范中摘取或引用。】 程序系统的组织结构 【用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。】 子系统划分 模块划分 程序与功能需求、系统模块间的关系 程序1（标识符）设计说明 【从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即
概要设计说明书示例【概要设计说明书(模板)】
概要设计说明书示例【概要设计说明书(模板)】 概要设计说明书 修订记录 目录 第一章 1.1.1. 2.1. 3.1. 4.第二章 2.1.2.2.2. 3.2. 4.2. 5.2. 6.2. 7.第三章 3.1.3.2.3.3.第四章 4.1.4.2.4.3.第五章 5.1.5.2.5.3.第六章 6.1. 6.2.6.3. 补救措施......................................................... ........................................10系统维护设计......................................................... .. (10) 第一章引言 1.1.编写目的 说明编写这份概要设计说明书的目的，指出预期的读者。 1.2.背景 说明：
a.待开发软件系统的名称； b.列出此项目的任务提出者、开发者、用户以及将运行该软件的站点。 1.3.定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4.参考资料 列出有关的参考文件，如： a.本项目的经核准的计划任务书或合同，上级机关的批文； b.属于本项目的其他已发表文件； c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出 第二章总体设计 2.1.需求规定 说明对本系统的主要的输入输出项目、处理的功能性能要求。 2.2.运行环境 简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定。 2.3.基本设计概念和处理流程 说明本系统的基本设计概念和处理流程，尽量使用图表的形式。 2.4.结构 用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。 2.5.功能需求与程序的关系
接口设计规范V1.0 - 参考
服务端与手机平台 接口协议 BespRout 2014年11月
文档修改/审批记录
目录 1.概述 (4) 2.涉及接口 (4) 3.接口总体要求 (4) 3.1.系统间接口的原则 (4) 3.2.处理流程 (4) 3.3.接口实现方式 (5) 4.XXX服务端接口 (5) 4.1.XX模块-根据XX下载相关的配置文件 (5) 4.2.XX模块-生成指定XX的文件配置 (6) 4.3.APP启动-初使化参数 (7) 5.附件 (8) 5.1.备注说明 (8)
1. 概述 本文档提供接口给手机端使用，为手机端提供业务平台数据 2. 涉及接口 本文档涉及的外围系统接口包括：无 3. 接口总体要求 3.1.系统间接口的原则 接口设计遵循如下原则： ?安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而 可靠的技术手段，制定严格的安全可靠的管理措施； ?开放性原则：提供开放式标准接口，提供与其它系统的互联互通； ?灵活性原则：提供灵活的接口设计，便于接口的变动。 ?可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高； ?可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便 的管理方式以处理各种情况； ?统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统 一。 3.2.处理流程 接口处理流程
3.3. 接口实现方式 手机APP 应用 与服务端采用基于HTTP 的REST 协议完成，数据传输默认为JSON 4. XXX 服务端接口 测试地址前缀: http://192.168.3.208:8088/xxx/xxx 4.1. XX 模块-根据XX 下载相关的配置文件
项目接口需求及设计说明文档(模板)
媒讯集团E A S项目 CTC与EAS接口 需求及设计说明书 文档作者： 创建日期：2013-05-10 确认日期： 当前版本：1.0 拷贝数量：1 审批签字: 客户方： 实施方：
文档控制
目录 1.概述 (4) 1.1读者 (4) 1.2图例 (4) 1.3目的 (4) 二、业务现状 (5) 三、概要设计 (5) 3.1接口通讯方式 (5) 3.2通讯内容定义 (5) 3.3媒讯CTC系统提供接口使用范例 (5) 3.4金蝶EAS提供接口使用范例 (5) 3.5媒讯CTC系统提供接口服务地址 (7) 3.6金蝶EAS提供接口服务地址 (7) 3.7接口需求 (7) 四、详细设计 (8) 4.1XX EAS接口 (8)
1.概述 金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。 1.1读者 本文读者对象为业务管理人员、系统设计、开发人员、测试人员。 1.2图例 本文中如未进行特殊说明，各图标代表的含义如下： 表示流程走向； 1.3目的 本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档，可用于指导开发、测试工作和作为验收相关依据文档。
二、业务现状 待补充 三、概要设计 3.1接口通讯方式 金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。 3.2通讯内容定义 对于记录型的大对象，在通讯时，采用String型的xml格式的参数进行传递。对于其他非记录型的对象，在通讯时，可采用非xml格式的参数进行传递，也可使用多个参数。具体格式，请参照每个接口的通讯用例说明。 3.3媒讯CTC系统提供接口使用范例 待补充。 3.4金蝶EAS提供接口使用范例 3.4.1规范说明 EAS通过webService接口与异构系统通信。EAS WebService全部是使用java编写的，其接口描述符合WSDL国际标准，其数据描述符合XSD 国际标准。 本次提供的接口除系统登录接口外，其他接口都需要调用登录接口，以便将登陆的SessionId信息放入到SOAP 的HEADER 报文中。 3.4.2使用示例 金蝶在EAS上发布WebService服务，提供wsdl文件供客户端下载，其他业务系统根据下载的wsdl文件，产生客户端。 建议使用Axis2来生成客户端代理。
京东API接口整理
1、类目API 获取商家类目信息 获取类目属性 通过类目属性ID获取属性值列表 设置商家级别的类目销售属性值 添加商家商品销售属性 更新商家商品销售属性 获取类目属性列表 获取类目属性值 获取单个类目信息 查找子类目列表 查询商家已授权的品牌 数据结构 item_cat categoryAttr类目属性对象 attrFeature类目属性特殊属性 categoryAttrGroup属性分组 attrGroupFeature属性分组特殊属性 categoryAttrValue类目属性值对象 attrValueFeature类目属性特殊属性 feature特殊属性 wareaddvender_sellsku添加商家商品销售属性
wareupdatevender_sellsku更新商家商品销售属性 brandList商家品牌List集合 2、店铺API 京东店铺API，包含提供商家、商家店铺基本信息及店内分类操作查询等功能。 添加卖家自定义店内分类 更新商家自定义店内分类 删除商家自定义店内分类 获取前台展示的商家自定义店内分类 查询商家基本信息 店铺信息查询 查询退货地址列表 查询发货地址列表 3、商品API 提供网站商品信息更新、查询API,该组下所有接口均不支持自营店铺业务 1. 新增商品 修改商品 商品上架 商品下架 删除商品信息 根据商品ID查询单个商品的详细信息 批量获取商品信息 检索商品信息
获取商品上架的商品信息 获取商品下架的商品信息 根据商品Id，销售属性值Id查询图片根据商品Id，销售属性值Id增加图片根据商品Id，销售属性值Id删除图片根据商品Id，销售属性值Id设置图片根据商品Id，检索商品图片 设置商品限购区域 查询商品限购区域 添加商品关联版式 修改商品关联版式 删除商品关联版式 查询关联版式id以及名称 查询关联版式详情 设置关联版式到商品 增加SKU信息 修改SKU信息 修改SKU库存信息 修改SKU价格信息 删除SKU 信息 根据外部ID获取商品SKU 根据商品ID列表获取商品SKU信息 获取单个SKU信息 回复商品评价 查询商品评价信息列表
api接口文档
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。 API：应用程序接口（API：Application Program Interface） 应用程序接口（是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。API 同时也是一种中间件，为各种不同平台提供数据共享。 根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将API 分为四种类型： 远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。 标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。 文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。 当前应用于API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付API 类型是比较理想的选择。 API 与图形用户接口（GUI）或命令接口有着鲜明的差别：API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。 有时公司会将API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式API。
LLD详细设计说明书模板
XX 详细设计说明书 拟制日期yyyy-mm-dd 评审人日期yyyy-mm-dd 批准日期yyyy-mm-dd <公司或企业图标> <公司或企业中英文名称> 版权所有侵权必究 （仅供内部使用）
修订记录 分发记录
目录 1简介 (6) 1.1目的 (6) 1.2范围 (6) 2详细设计 (6) 2.1模块1详细设计 (6) 2.1.1数据描述 (6) 1.简单数据描述； (6) 2.结构1 (6) 3.结构2 (7) 2.1.2函数描述 (8) 1.函数1 (8) 2.函数2 (9) 2.2模块2详细设计 (10) 2.3错误处理 (10) 2.3.1系统错误 (10) 2.3.2接口错误 (10) 2.3.3协议错误 (10)
表目录No table of contents entries found.图目录 Figure 1Module 1 Structure Chart 模块1结构图 (8)
XX 详细设计说明书 关键词： 摘要： 缩略语清单：<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。
1 简介 1.1 目的 描述本文的目的，一般详细设计必须能够直接指导编码活动。 1.2 范围 本节应描述文档所包括和不包括的内容。 2 详细设计 对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。 2.1 模块1详细设计 描述模块中定义和使用的数据，包括： 简单数据，如模块级的全局变量、常量、宏； 复合数据，如模块内部的结构、联合...； 2.1.1 数据描述 在2.1.1.1中描述本模块中的简单变量、常量、宏； 从2.1.1.2起描述本模块中的复合数据，如结构、联合等； 1. 简单数据描述； 描述在本模块中定义和使用的简单变量、常量、宏； 按照下列格式进行简单数据的描述 功能描述：描述该数据的用途 数据定义：定义该数据 2. 结构1 定义和说明该数据结构(包括联合); 按照下列格式进行数据结构的描述 数据结构描述：描述该数据结构的用途 数据结构定义：用实际的编程语言定义该数据结构 数据项描述：
CSCI详细设计说明书模板
文档编号： 项目名称 XXXX CSCI详细设计说明书 单位名称 XXXX年X月
修改记录
1 范围 1.1 标识 1.2 CSCI 概述 1.3 文档概述 2 引用的文档 3 CSCI 设计 3.1 CSCI结构 3.2 CSCI运行组织 3.3 CSCI性能要求 3.4 CSCI设计限制和约束 3.5 CSCI测试计划 4 CSC 设计 4.x CSC的名称和唯一标识符 4.x.y 下一级CSC的名称和唯一标识符 5 CSCI数据说明 5.1 CSCI内部数据元素 5.2 CSCI外部接口数据元素 6 CSCI数据文件 6.1 CSC和CSU数据文件的交叉引用 6.x数据文件名和唯一标识符 7 需求可追踪性
1.1 标识 【系统背景】 系统标识符：（系统标识符） 系统名称：（系统名称） 缩写：给出系统的缩写 【适用的CSCI】 标识符：（CSCI标识符） 名称：（CSCI名称） 缩写：给出CSCI的缩写 1.2 CSCI 概述 【系统功能概述】 简要描述本系统的功能。 【CSCI功能概述】 （给出CSCI在需求规格说明书中对应的需求规格标识号的引用）。 如有必要可用图示表示本CSCI在系统中的位置（顶层系统结构图）。1.3 文档概述 【用途】 本文档用于描述在进行CSCI详细设计中每个阶段的设计结果，提供CSCI 的详细设计说明书。 【内容】 本文档的主题内容如下： 描述CSCI的功能和作用； 定义CSCI的结构（用一组CSC，以及这些CSC之间的接口关系，定义CSC 的名称，标示符，分配的需求集）； 定义CSCI设计限制； 定义CSCI资源使用设计； 定义CSCI每个CSC以及CSU的详细设计。 描述每个CSC可追溯的需求规格和接口规格说明。