接口详细设计文档 (1)
1 编写目的 (4)
2 名词解释 (4)
3组件分布图 (5)
4 程序结构 (6)
4.1 接入处理线程类图 (6)
4.2 接收线程类图 (7)
4.3 启动控制图 (7)
5 程序设计说明 (8)
5.1 对原系统的改动 (8)
5.2 ThreadInSvcProcessor 接入处理器 (9)
5.2.1 类图 (9)
5.2.2 时序图 (10)
5.2.3 流程图 (10)
5.2.4 ThreadInSvcProcessor类说明 (12)
5.3 PatternNewSyncAsyncInnerDir 同异步向内处理模式 (17)
5.3.1 类图 (17)
5.3.2 描述 (18)
5.3.3 流程图 (18)
5.3.4 类说明 (20)
5.4 ThreadReplySvcProcessor 异步应答返回处理器 (25)
5.4.1 类图 (25)
5.4.2 类说明 (25)
5.5 ClientInfo 客户端连接数据 (34)
5.5.1 类图 (34)
5.5.2 类描述 (34)
5.6 ClientInfoTable 客户端连接数据表 (35)
5.6.1 类图 (35)
5.6.2 类描述 (35)
5.7 ClientInfoTableMonitor 客户端连接数据表监控程序 (39)
5.7.1 类图 (39)
5.7.2 类说明 (39)
5.8
FrontMain 主控程序 .............................................................................................. 41 5.8.1
类间关系 ......................................................................................................... 41 5.8.2
流程图 ............................................................................................................. 42 5.8.3 类说明 . (43)
5.9 问题 (45)
编写目的
预期读者：
对接口行为和目的有一定了解的人
背景说明
?软件系统名称：接口前端接入服务器
?描述<接口> 接收不同商家的接入，接收数据转发给主机服务器，并同步/异步将
返回数据发给接入商家的行为
名词解释
?ChannelBase 渠道,通信基类，提供数据收发和释放的方法接口用子类实现来
封装了不同通信方式目前有TCP短连接接入，从ACE Message_Queue中读取
（IPC MessageQueue-> ACE_Message_Queue）
?Trade* trade 商家对象，代表的其实是针对该商家处理方法的集合将接入数据的商
家称为服务商家而将请求面向的商家称为主机商家，主机商家负责同步/异步返回
交易的应答数据给接口平台
?而接口（数据交换）平台是在两者之间的交换平台
?渠道工厂：把接入数据的渠道工厂统一定为服务渠道工厂，发送数据的渠道工厂统
一定为主机通道工厂
程序结构
接入处理线程类图
ThreadInSvcProcess or 是接入处理线程的主流程
收数，接包无误后将处理控制权交给
ProcessPattern 是后续处理的全部流程 抽象类
接收线程类图
启动控制图
程序设计说明
对原系统的改动
?改变原有商家Trade类，不存放渠道对象在商家类中，商家类只执行商家处理，不
负责渠道的管理
?改动原有的系统中所有模式的处理，模式处理必须对渠道的释放负责
?修改MidHstChannel，添加后台服务需要的２个FML字段,这两个字段是:
ThreadInSvcProcessor 接入处理器类图
时序图
预先说明：
? ChannelBase 渠道通信基类，提供数据收发和释放的方法接口用子类实现来封装了
不同通信方式。目前有 TCP 短连接接入。从ACE Message_Queue 中读取（IPC MessageQueue-> ACE_Message_Queue ）
? Trade* trade 商家：代表的其实是针对该商家处理方法的集合
流程图
ThreadInSvcProcessor 类说明
功能
收取用不同渠道接入的外部商家的请求识别，解包执行处理的模式具体的流程在模
式中控制,并不做控制 模式可能有3种：
? 无返回：发送后台，不接收应答对应模式PatternASyncInnerDir,需要修改原来的相关程
序,在本文档中并不涉及
? 有返回,根据返回的应答判断是同步返回还是异步返回如果接收的应答表明是同步返
回，按正常模式返回如果接收的应答表明是异步返回，按异步模式处理对应模式PatternNewSyncASyncInnerDirThreadInSvcProcessor 后续的ProcessPattern 应该是PatternNewSyncASyncInnerDir.ThreadInSvcProcessor 只负责接入后调用模式，并处理异常情况
? 安全异常情况的模式下，调用模式PatternErrorSyncInner 来处理，必须限制： 主要的
改动是渠道的释放由模式来管理涉及模式有 PatternASyncInnerDir , PatternNewSyncASyncInnerDir , PatternErrorSyncInner （可能不全面）
程序描述 ThreadInSvcProcessor
功能: 构造函数
性能:
输人项: Trade* trade 接入数据处理的商家类 SvcChannelFactory* pfactory 接入数据渠道工厂
bool* exit
退出标志
输出项: 注释:
程序描述SvcRun
功能: 主控流程
输人项: 无
输出项: 无
流程
:服务商家在开始已经生成，生存周期里一直存在一个DataBus对象（数据总线），每线程一个DataBus对象。在生存周期里一直存在
程序描述a_process_loop
功能:一次交易的处理
输人项: Trade* pTrade , 接收数据的服务商家服务渠道
SvcChannelFactory* pFactory,服务商家接收数据的主机通道
SvcChannelFactory * pFactory 服务商家渠道的生成工厂。
DataBus* pDataBus预先创建的数据总线，不需要每次重建
输出项: S_OK 成功完成
其他 出错信息
流程:
异常处理: 记录出错信息和时间
当异常发生在ExecPattern 之外,释放渠道
结束处理: (无论异常与否都执行):
释放对方商家 ｈst_trade
释放模式对象Pattern 注释:
为了便于单元测试，从SvcRun 中分离出该方法
也可以在SvcRun 中实现上述的全部逻辑
程序描述GetChannel
功能:调用svc_factory生成服务渠道
性能:
输人项: SvcChannelFactory* svc_factory 渠道工厂
ACE_Time_Value* time_val 超时时间这个超时目前是一个固定值，和接收数据和发送数据的超时无直接联系
ChannelBase* !=NULL 未取得=NULL 取得
输出项: 返回值
注释:出错信息在该方法中输出流程中只判断是否取得，没有取得则应该跳到开头进入下一次循环
测试：对所有的可能生成的ChannelBase都进行一次测试
程序描述TradeRecvData
功能: 商家通过渠道接收数据放入p_databus中
输人项: ChannelBase* p_chnbase 收取的渠道
Trade* p_recv_trade 接收的商家
DataBus* p_databus 存放数据的DataBus
ACE_Time_Value* time_out 超时时间
输出项: 0 成功
-1 读取失败或者超时
注释:主流程不记录详细出错信息
程序描述TradeInProcess
功能: 执行商家的入口处理(识别，解包。。。) p_databus
的_data_buff 和 _len 字段分别表示数据指针和长度
输入处理后将数据填入 p_databus 的 _var_pool 和 _var_reco_pool （识别数据）中
输人项: Trade* p_ trade 接收服务商家
DataBus* p_databus
存放数据的DataBus
输出项: 0
成功
-1
读取失败或者超时
注释:
没有超时限制,要控制短时间内完成
程序描述RequestSecureFailedProcess
功能: 对输入是请求报文的安全类函数失败后的处理(输入是应答报文的就直接丢弃)
输人项: DataBus* p_databus 数据 Trade* p_trade
输入服务商家
ChannelBase* in_svc_channel
输入服务的渠道
输出项: S_OK 应答保报文，不加理会
INTIDENERROR( SECUFAILED )
请求报文，执行安全异常处理模式成功
其他。 请求报文，执行安全异常处理模式中出错
注释:无论SecureFailedProcess 的执行结果如何都不继续执行后面的操作
程序描述ExecPattern
功能: 执行处理模式,全部处理交给pattern
输人项: ProcessPattern* pattern 处理模式
DataBus* p_databus 存放数据的数据总线
ChannelBase* channel 输入服务渠道,交给Pattern管理释放
输出项: S_OK 成功
其他失败
注释: ChannelBase* 输入渠道，如果Pattern没有生成等错误，还是主控来释放p_channel 执行pattern->Process 后就不管了可能设置一个标志位来表示是否执行了Pattern，执行过最后就不用释放channel了
(是否可以这样？
主程序都删除p_channel，但是ExecPattern有可能返回的p_channel 是NULL。此时的主控是什么都不做。如果非null就删除)
PatternNewSyncAsyncInnerDir 同异步向内处理模式
类图
描述
预先了解：
交换平台接入的是服务商家,发送的是主机商家（主机）PatternNewSyncAsyncInnerDir 继承 ProcessPattern 类
流程图
见下页
类说明
构造函数PatternNewSyncAsyncInnerDir
svc_trade 和 host_trade 分别代表服务商家和主机商家
方法Process
DataBus * p_databus 数据总线,包含了解包解开的数据 (FML 格式)
ChannelBase* p_inchannel 服务商家接入的渠道 ACE_Time_Value * time_val 超时时间
这样我们就拥有了处理需要的全部信息。而其他缺少的是在执行中生成的信息了
程序描述TradeOutProcess
功能: 执行商家输出处理
将数据处理（打包，加密。。。）处理到发送前的状态 输人项: Trade* p_trade 商家
XXX软件/项目/系统 详细设计说明书 拟制日期 评审人日期 批准日期 编写单位或个人
修订历史
目录 XXX软件详细设计说明书 (1) Revision Record 修订记录 (2) 1引言 (1) 1.1编写目的 (1) 1.2背景 (1) 1.3参考资料 (1) 1.4术语定义及说明 (1) 2设计概述 (1) 2.1任务和目标 (1) 2.1.1需求概述 (1) 2.1.2运行环境概述 (1) 2.1.3条件与限制 (1) 2.1.4详细设计方法和工具 (1) 3系统详细需求分析 (1) 3.1详细需求分析 (2) 3.2详细系统运行环境及限制条件分析接口需求分析 (2) 4总体方案确认 (2) 4.1系统总体结构确认 (2) 4.2系统详细界面划分 (2) 4.2.1应用系统与支撑系统的详细界面划分 (2) 4.2.2系统内部详细界面划分 (2) 5系统详细设计 (2) 5.1系统结构设计及子系统划分 (3) 5.2系统功能模块详细设计 (3) 5.3系统界面详细设计 (3) 5.3.1外部界面设计 (3) 5.3.2内部界面设计 (3) 5.3.3用户界面设计 (3) 6、数据库系统设计 (4) 6.1设计要求 (4) 6.2 信息模型设计 (4) 6.3数据库设计 (4) 6.3.1设计依据 (4) 6.3.2数据库种类及特点 (4) 6.3.3数据库逻辑结构 (4) 6.3.4物理结构设计 (4) 6.3.5数据库安全 (4) 6.3.6数据字典 (4) 7非功能性设计 (4) 8 (5) 9环境配置 (5)
1引言 1.1编写目的 说明编制的目的是，大体上介绍一下软件系统中各层次中模块或子程序、以及数据库系统的设计考虑，表明此文档是主要是为编码人员提供服务，并且其他类型的项目参与人员也可以通过此文档对软件/项目有更深入了解。 1.2背景 说明此软件或系统的项目背景、需求背景、开发目的等，还可以列出参与人员等相关信息。 1.3参考资料 列出本文档中引用的文献、资料、标准等相关信息（一般是具有出版或版权性质的文件）。 1.4术语定义及说明 列出文档中用到的和开发有关，或与行业、业务、需求有关的专业术语，并进行解释。 2设计概述 2.1任务和目标 说明详细设计的任务及详细设计所要达到的目标。 2.1.1需求概述 对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。 2.1.2运行环境概述 对本系统所依赖于运行的硬件，包括操作系统、数据库系统、运行库、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。 2.1.3条件与限制 详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。 2.1.4详细设计方法和工具 简要说明详细设计所采用的方法和使用的工具，如数据库设计工具、界面设计工具、原型设计工具等。 3系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。
产品/项目名称Product/Project Name 保密级别Confidentiality Level eYou邮件系统机密 产品/项目版本Product/Project Version 最后更新日期Last Update 81032014-09-12 eYou邮件系统V8接口文档 北京亿中邮信息技术有限公司 All Rights Reserved 版权所有侵权必究 仅供内部使用
Revision Record 修订记录
目录 1 API接口简介------------------------------------------------------------------------------------------------------- 3 2 API认证概述------------------------------------------------------------------------------------------------------- 4 认证方式的分类 --------------------------------------------------------------------------------------------- 4认证方式的选择 --------------------------------------------------------------------------------------------- 5认证原理 ------------------------------------------------------------------------------------------------------- 5 3 认证方法详解及示例-------------------------------------------------------------------------------------------- 5 OAuth ----------------------------------------------------------------------------------------------------------- 5 eYouAuth ------------------------------------------------------------------------------------------------------- 5 SSO API的eYouAuth认证方法：----------------------------------------------------------------- 5 Feed API的eYouAuth认证方法： --------------------------------------------------------------- 7 申请会话Token：------------------------------------------------------------------------------------- 8 4 API接口调用示例 ---------------------------------------------------------------------------------------------- 10 Feed API调用----------------------------------------------------------------------------------------- 10 资源概述 ---------------------------------------------------------------------------------------------- 10 以用户的增删改查为例，示例各种Feed API调用步骤--------------------------------- 11 5 附表 ---------------------------------------------------------------------------------------------------------------- 13 1 API接口简介 API指eYou邮件系统所提供的接口。 调用接口流程图：
XXX）科技有限公司 数据接口 2015-5-26
目录 第1章引言. ......................................................... 错误!未定义书签。 背景. ........................................................... 错误!未定义书签。 第2章接口与数据定义. ................................................... 错误!未定义书签。 曝光台查询接口. ..................................................... 错误!未定义书签。 曝光台列表查询.......................... 错误!未定义书签。 曝光台详情查询.......................... 错误!未定义书签。 信用公示查询接口定义.......................... 错误!未定义书签。 守信公示列表查询.......................... 错误! 未定义书签。 守信公示详情查询.......................... 错误!未定义书签。 失信公示列表查询.......................... 错误!未定义书签。 失信公示详情查询.......................... 错误!未定义书签。 企业名称查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。 企业信息查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。
软件开发文档模板 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案 1 1.5.2 可选择的系统方案 2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资
1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点
帝国CMS接口使用手册 一、简介 1、本接口应用于帝国CMS 版新闻系统模型的栏目文章发布； 2、本接口可以自动生成文章、栏目、首页等静态HTML页面； 3、本接口可以生成随机点击数，详见发布接口参数说明； 4、发布时请使用管理员用户帐号； 5、在帝国CMS utf8版使用本接口时，请在发布规则中选择编码为UTF-8； 6、本接口基于帝国CMS UTF8版制作，适用于帝国CMS GBK/utf-8等版本，应用于其他版本时请自行测试调整；； 7、接口文件无须任何改动即可使用，如果你希望增加校验或其他功能，请仔细修改； 8、2个接口文件请复制在网站 /e/admin目录下使用； 二、安装接口 在接口文件夹中找到接口文件，如图： 请将、等接口文件上传到指定目录，请使用二进制方式上传，如图： 三、配置发布规则 1、将范例发布规则文本导入ET2发布配置，或使用软件内置发布规则范例，如图：
2、将检查网址和发布网址中的“您的网站”改为您要发布的网站网址，如图： 3、在检查网址填上您要发布的栏目ID，如图： 4、在参数取值页，填上您要发布的网站栏目ID，如图： 这里查看栏目ID：
4、填上您的管理账号、密码，注意格式，如图： 四、接口说明 一、检查接口 1、接口文件名，为保密，请自行修改文件名； 2、本接口文件复制在网站/e/admin目录使用，如果目录名有变更，请自行对应； 3、主要参数 keyboard 文章标题 classid 栏目ID，用于指定检查栏目，可在后台网站栏目管理处查看； vercode 校验码，请自行设定，并在检查接口文件开始处修改$vercode 使其一致； 4、发布配置-文章检查网址处，可以如下填写： 注：使用大小写敏感的服务器的用户请注意网址大小写和网站文件一致 5、接口文件无须任何改动即可使用，如果你希望增加校验或其他功能，请仔细修改； 二、发布接口 1、接口文件名，为保密，请自行修改文件名； 2、本接口文件请复制在网站/e/admin目录下使用，为保密，请自行修改文件名；
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}
目录 1. 范围 (1) 2. 总体要求 (1) 2.1总体功能要求 (1) 2.2软件开发平台要求 (1) 2.3软件项目的开发实施过程管理要求 (2) 2.3.1 软件项目实施过程总体要求 (2) 2.3.2 软件项目实施变更要求 (2) 2.3.3 软件项目实施里程碑控制 (3) 3. 软件开发 (4) 3.1软件的需求分析 (4) 3.1.1 需求分析 (4) 3.1.2 需求分析报告的编制者 (5) 3.1.3 需求报告评审 (5) 3.1.4 需求报告格式 (5) 3.2软件的概要设计 (5) 3.2.1 概要设计 (5) 3.2.2 编写概要设计的要求 (6) 3.2.3 概要设计报告的编写者 (6) 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 (6) 3.2.5 概要设计的评审 (6) 3.2.6 概要设计格式 (6) 3.3软件的详细设计 (7) 3.3.1 详细设计 (7) 3.3.2 特例 (7) 3.3.3 详细设计的要求 (7) 3.3.4 数据库设计 (7) 3.3.5 详细设计的评审 (7) 3.3.6 详细设计格式 (8) 3.4软件的编码 (8) 3.4.1 软件编码 (8) 3.4.2 软件编码的要求 (8) 3.4.3 编码的评审 (8) 3.4.4 编程规范及要求 (8) 3.5软件的测试 (9) 3.5.1 软件测试 (9) 3.5.2 测试计划 (9)
3.6.1 交付清单 (9) 3.7软件的鉴定验收 (10) 3.7.1 软件的鉴定验收 (10) 3.7.2 验收人员 (10) 3.7.3 验收具体内容 (10) 3.7.4 软件验收测试大纲 (11) 3.8培训 (11) 3.8.1 系统应用培训 (11) 3.8.2 系统管理的培训（可选） (11) 1. 引言 (19) 1.1编写目的 (19) 1.2项目风险 (19) 1.3文档约定 (19) 1.4预期读者和阅读建议 (20) 1.5产品范围 (20) 1.6参考文献 (20) 2. 综合描述 (21) 2.1产品的状况 (21) 2.2产品的功能 (22) 2.3用户类和特性 (22) 2.4运行环境 (22) 2.5设计和实现上的限制 (23) 2.6假设和约束(依赖) (23) 3. 外部接口需求 (24) 3.1用户界面 (24) 3.2硬件接口 (25) 3.3软件接口 (25) 3.4通讯接口 (26) 4. 系统功能需求 (26) 4.1说明和优先级 (27) 4.2激励／响应序列 (27) 4.3输入／输出数据 (28) 5. 其它非功能需求 (28) 5.1性能需求 (28) 5.2安全措施需求 (29) 5.3安全性需求 (29) 5.4软件质量属性 (29) 5.5业务规则 (29) 5.6用户文档 (30)
《XXXXXX》概要设计说明书 张三、李四、王五
1．引言 1．1编写目的 在本机票预定系统项目的前一阶段，也就是需求分析阶段中，已经将系统用户对本系统的需求做了详细的阐述，这些用户需求已经在上一阶段中对航空公司、各旅行社及机场的实地调研中获得，并在需求规格说明书中得到详尽得叙述及阐明。 本阶段已在系统的需求分析的基础上，对机票预定系统做概要设计。主要解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息，以及数据结构、模块结构的设计等。在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。 在下一阶段的详细设计中，程序设计员可参考此概要设计报告，在概要设计对机票预定系统所做的模块结构设计的基础上，对系统进行详细设计。在以后的软件测试以及软件维护阶段也可参考此说明书，以便于了解在概要设计过程中所完成的各模块设计结构，或在修改时找出在本阶段设计的不足或错误。 1．2项目背景 机票预定系统将由两部分组成：置于个旅行社定票点的前台客户程序，以及置于航空公司的数据库服务器。本系统与其他系统的关系如下： 1．3定义 1．3．1 专门术语 SQL SERVER: 系统服务器所使用的数据库管理系统（DBMS）。 SQL: 一种用于访问查询数据库的语言 事务流：数据进入模块后可能有多种路径进行处理。 主键：数据库表中的关键域。值互不相同。 外部主键：数据库表中与其他表主键关联的域。 ROLLBACK: 数据库的错误恢复机制。 1．3．2 缩写
系统：若未特别指出，统指本机票预定系统。 SQL: Structured Query Language（结构化查询语言）。 ATM: Asynchronous Transfer Mode (异步传输模式)。 1．4参考资料 以下列出在概要设计过程中所使用到的有关资料： 1．机票预定系统项目计划任务书浙江航空公司1999/3 2．机票预定系统项目开发计划《**》软件开发小组1999/3 3．需求规格说明书《**》软件开发小组1999/3 4．用户操作手册（初稿）《**》软件开发小组1999/4 5．软件工程及其应用周苏、王文等天津科学技术出版社1992/1 6．软件工程张海藩清华大学出版社1990/11 7．Computer Network A.S.Tanenbaun Prentice Hall 1996/01 文档所采用的标准是参照《软件工程导论》沈美明著的“计算机软件开发文档编写指南”。 2．任务概述 2．1 目标 2．2 运行环境 系统将由两部分程序组成，安装在各旅行社客户机上的客户程序及航空公司内的数据服务器程序。 根据调研得知所有旅行社的计算机配置均在Pentium 133级别以上，客户程序应能够在Pentium 133级别以上, Win NT环境下运行。 2．3 需求概述 浙江航空公司为方便旅客，需开发一个机票预定系统。为便于旅客由旅行社代替航空公司负责为旅客定票，旅行社把预定机票的旅客信息，包括姓名、性别、工作单位、身份证号码、旅行时间、旅行目的地，输入机票预定系统的客户端程序，系统经过查询航空公司内的航班数据服务器后，为旅客安排航班，印出取票通知。旅客在飞机起飞前一天凭取票通知和帐单交款后取票，系统校对无误后即印出机票给旅客。 要求系统能有效、快速、安全、可靠和无误的完成上述操作。并要求客户机的界面要简单明了，易于操作，服务器程序利于维护。 2．4 条件与限制 3．总体设计 3．1 处理流程 下面将使用（结构化设计）面向数据流的方法对机票预定系统的处理流程进行分
精品文档 软件项目名称 错误！未指定书签。 拟制：日期： 审核：日期： 批准：日期：
文件修改记录
目录 1范围 (4) 2 总体概述 (4) 2.1 产品描述 (4) 2.2 软件功能 (4) 2.3 一般约束 (5) 2.4 假设和依赖 (5) 3 具体需求 (5) 3.1 功能需求 (5) 3.1.1 功能需求1 (5) 3.1.2 功能需求2 (6) 3.1.n 功能需求n (7) 3.2 外部接口需求 (7) 3.2.1 用户接口 (7) 3.2.2 硬件接口 (7) 3.2.3 软件接口 (7) 3.2.4 通讯接口 (7) 3.3 性能需求 (7) 4 设计约束 (8) 4.1 标准的约束 (8) 4.2 硬件的限制 (8) 4.3 技术的限制 (8) 5 软件质量属性 (8) 5.1 安全性 (9) 5.2 可维护性 (9) 5.3 可移植性 (9) 6 其他需求 (9) 6.1 数据库 (9) 6.2 本地化 (10) 7待确定问题 (10)
模板使用说明： [1]注明可选的部分，可以根据实际情况选择是否填写；如果不必说明，请保留相关的章节标题，同时在该可选章节的内容中填入“无”；未注名可选的，则必须描述；如果有些设计此模版中没有合适的地方填写，则补充在最后的其他栏目中 [2]模版中斜体字相当于撰写指南，最后文稿请将本模板中所有的斜体字部分全部删除。 [3]模板里并不说明设计技术和方法，而只是说明应包含哪些内容，以及如何描述、组织这些内容。
1范围 说明文档所包括和不包括的内容，具体是： a．待开发的软件系统的名称； b．说明软件将干什么，如果需要的话，还要说明软件产品不干什么； c．描述所说明的软件的应用。如果有一个较高层次的说明存在，则应该使其和高层次说明中的类似的陈述相一致（例如，系统的需求规格说明）。 2 总体概述 2.1 产品描述 叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。 2.2 软件功能 概述软件必须实现的和通过用户操作实现的主要功能。这里只需要进行简要描述（例如目录列表），详细描述在详细需求部分描述。 有时，如果存在较高层次的规格说明时，则功能摘要可从中取得，这个较高层次的规格说明为软件产品分配了特殊的功能，为了清晰起见，请注意： a．编制功能的一种方法是制作功能表，以便客户或者第一次读这个文件的人都可以理解； b．用方框图来表达不同的功能和它们的关系也是有帮助的。但应牢记，这样的图不是产品设计时所需求的，而只是一种有效的解释性的工具。 例如：高层的数据流图，面向对象的分析等。
XXX接口说明书(版本：V1.0)
修订记录
1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如： 结构：data（数据）、errorCode（状态码）、msg（提示信息） { data:{}, // 数据类型不一定为object类型 errorCode:10001, msg:'' } (4) 枚举型参数应列举参数所有值及说明 例如： gender：性别（男：1，女：2） userInfo:{ name:'张三', age:23, gender:1 }
(5) 具有嵌套关系的参数应指明嵌套关系及子级数据结构例如： billList: 账单列表(父级) billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] (6) 返回参数数据类型保持一致性 例如： billList: 账单列表（有数据） billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] billList: 账单列表（无数据） billList:[] 返回的参数数据类型都为：array (7) 下拉及选择型数据以键值对的形式返回 例如： orderOperate：订单操作 orderOperate:[
中国移动短信网关 SP端接口使用手册 China Mobile Shot Message Gateway Interface for SP Manual 作者：沈岗 日期：2004年1月 版本：V1.2
一、CMSMIF.CMPPApp 简要说明： 该类采用CMPP协议(V2.0)实现了SP端与移动短信网关的连接处理。 本类中，采用长连接方式与ISMG通讯。通信双方以客户-服务器方式建立TCP连接，用于双方信息的相互提交。当信道上没有数据传输时，通信双方应每隔时间C发送链路检测包以维持此连接，当链路检测包发出超过时间T后未收到响应，立即再发送链路检测包，再连续发送N-1次后仍未得到响应则断开此连接。参数C、T、N可通过属性配置。 消息发送时采用并发方式，即发送一条消息不等待网关回复确认，继续向网关发送短信，这样发送消息速度非常快，完全取决于网关的处理速度及网络速度。为避免消息丢失，同时采用了滑动窗口流量控制，窗口大小可通过属性设置。 消息接收、网络断开等采用事件触发方式，不需应用程序轮询，在此接口基础之上编程方便。 类中运用了多线程技术，如一条线程处理发送网络包，而另一条线程处理从网关上接收网络包，其他还有一些线程处理检测包、网络连接情况监测等，使程序思路明确、执行效率很高、运行非常稳定。 （一）属性 1.ActiveInterval 说明：检测包发送时间间隔，单位：毫秒。默认值为120000，即120秒。为上 述类说明中的C参数。 2.MaxNetworkPackSize 说明：与ISMG通讯时最大网络包大小，单位：字节。默认值为512Byte。 3.MaxRetryTimes 说明：网络超时最大重发次数,单位：次。默认值为3次。为类说明中的N。 4.OverTime 说明：网络包发送超时时间,单位:毫秒,超过此值还未收到回复则重发。默认值 为60000，即60秒。为类说明中的T。 5.QueueLength 说明：网络队列大小，单位：个，默认值为20。为类说明中的滑动窗口大小， 以控制发送流量。 （二）方法 1.ConnectToIsmg 方法说明： 连接到远程短信网关ISMG上，只有连接到远程短信网关上，才可进行短信收发操作。 在本操作中，自动初始化本地Socket，以连接到指定IP服务器的指定端口上。 声明原型：int ConnectToIsmg(string ServerIP,int Port,string SP_ID,string Secret，string SN) 参数说明： ServerIP：远程短信网关服务器的IP地址，如211.138.200.51 Port：远程短信网关服务器的端口号，如7890 SP_ID：企业服务代码
软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1
1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题
目录 三、需求规格说明书 (2) 四、概要设计说明书 (12) 五、详细设计说明书 (15)
3软件需求说明书 软件需求说明书的编制是为了使用户的软件开发者双方对该软件的起初规定有一个共同的理解，使之成为整个开发工作的基础。编制软件需求说明书的内容要求如下： 3.1引言 3.1.1编写的目的 3.1.2背景 3.1.3定义 3.1.1参考资料 3.2任务概述 3.2.1目标 3.2.2用户的点 3.2.3假定与约束 3.3需求规定 3.3.1对功能的规定 3.3.2对性能的规定
3.3.2.1精度 3.3.2.2时间特性要求 3.3.2.3灵活性 3.3.3输入输出要求 3.3.4数据管理能力的要求 3.3.5故障处理要求 3.3.6其它的专门的要求 3.4运行环境规定 3.4.1设备 3.4.2支持软件 3.4.3接口 3.4.4控制 4数据需求说明书 数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描述和数据采集要求的技术信息。编制数据要求说明书的内容要求如下： 4.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.2.4内部生成数据 4.2.5数据约定 4.3数据的采集 4.3.1要求和范围 4.3.2输入的承担者 4.3.3处理 4.3.4影响 5概要设计说明书 概要设计说明书可称作系统设计说明书，这里说的系统是指程序系统，编制的目
的是说明对程序的系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容要求如下： 5.1引言 5.1.1编写目的 5.1.2背景 5.1.3定义 5.1.4参考资料 5.2总体设计 5.2.1需求规定 5.2.2运行环境 5.2.3基本设计概念和处理流程 5.2.4结构 5.2.5功能需求与程序的关系 5.2.6人工处理过程
接口使用说明书 2016年9月
版本控制文档信息 文档变更记录
目录 1.接口概述 (4) 1.1. 概述 (4) 1.2. 基本规则 (4) 1.2.1. 域名 (4) 1.2.2. 通用接口调用参数说明 (4) 2.接口定义 (6) 2.1. 登录注册 (6) 2.1.1. 登录接口 (6) 2.1.1.1. 账号密码登录 (6) 2.1.1.2. 微信登录............................................................................. 错误！未定义书签。 2.1.2. 注册和修改接口..................................................................... 错误！未定义书签。 2.1.2.1. 完善个人信息接口............................................................. 错误！未定义书签。 2.1.2.2. 获取个人资料..................................................................... 错误！未定义书签。 2.1.2. 3. 上传/修改企业信息 ........................................................... 错误！未定义书签。 2.1.2.4. 上传/修改工作经历 ........................................................... 错误！未定义书签。 2.1.2.5. 设置/修改提现密码 ........................................................... 错误！未定义书签。 2.1. 3. 短信部分接口......................................................................... 错误！未定义书签。 2.1. 3.1. 发送短信验证码接口......................................................... 错误！未定义书签。 2.1.4. 服务部分接口......................................................................... 错误！未定义书签。 2.1.4.1. 上传/修改个人服务信息 ................................................... 错误！未定义书签。 2.1.4.2. 获取服务列表..................................................................... 错误！未定义书签。 2.1.4. 3. 获取服务详情..................................................................... 错误！未定义书签。 2.1.4.4. 评价列表(全部服务或单个服务) ...................................... 错误！未定义书签。 2.1.4.5. 预约..................................................................................... 错误！未定义书签。 2.1.4.6. 服务评价............................................................................. 错误！未定义书签。 2.1.5. 我的账户................................................................................. 错误！未定义书签。 2.1.5.1. 获取用户收入/支出记录 ................................................... 错误！未定义书签。 2.1.5.2. 分页获取收入/支出记录 ................................................... 错误！未定义书签。 2.1.5. 3. 添加收入/支出记录 ........................................................... 错误！未定义书签。 2.1.6. 红包部分接口......................................................................... 错误！未定义书签。 2.1.6.1. 领取红包............................................................................. 错误！未定义书签。 2.1.6.2. 发放红包............................................................................. 错误！未定义书签。 2.1.7. 精英汇部分接口..................................................................... 错误！未定义书签。 2.1.7.1. 获取精英列表..................................................................... 错误！未定义书签。 2.1.7.2. 精英详情............................................................................. 错误！未定义书签。 2.1.8. 任务接口................................................................................. 错误！未定义书签。 2.1.9. 其他接口................................................................................. 错误！未定义书签。 2.1.9.1. 消息..................................................................................... 错误！未定义书签。 2.1.9.2. 省市区获取......................................................................... 错误！未定义书签。 2.1.9. 3. 行业类型获取..................................................................... 错误！未定义书签。 2.1.9.4. 上传多媒体资源................................................................. 错误！未定义书签。