6、项目接口规范说明书
湖南省地方金融征信与监管服务平台金融生态建设管理系统
接
口
规
范
说
明
书
省政府金融办信息中心
中科软科技股份有限公司
2015年12月
记录更改历史
目录
第1章系统接口 (4)
第2章获取金融机构数据接口 (4)
第3章获取金融业数据接口 (4)
第4章提供手机APP接口 (5)
第5章提供微信接口 (6)
第1章系统接口
数据接口的传送方式以JSON数据格式包装数据，对于保密安全级别高的数据，传送过程进行数据加密，防止数据泄密影响数据安全。第2章获取金融机构数据接口
●从金融服务平台中获取金融机构数据。
获取金融机构基本信息，用于在GIS上显示。
接口名：queryFinancialInstitution4Gis
输入数据项：机构类型、地区。
返回数据项：机构类型、地区、机构名称、联系人、联系方式、地址、经度、纬度。
第3章获取金融业数据接口
从门户网站中数据上报系统中获取金融业数据。
●获取数据名称
获取哪些数据可以查询。
接口名：queryIndexData4Gis
输入数据项：无。
返回数据项：数据名称
●获取数值
获取具体数据的值。
接口名：queryIndexData4Gis
输入数据项：数据名称(如：上市企业数)、时间(多个)、地区(多个)。
返回数据项：数据名称、时间、地区、数值。
第4章提供手机APP接口
●获取文档列表接口
接口名：queryDocListData
输入数据项：栏目、最后获取时间。
返回数据项：文档id、文档标题、发布时间。
●获取文档内容
接口名：queryDocContentData
输入数据项：文档id。
返回数据项：文档标题、文档内容、发布人、发布时间。
●登录
接口名：queryLoginData
输入数据项：用户名、密码。
返回数据项：单位、部门、用户名等用户基本信息。
●获取指标
接口名：getIndexList
输入数据项：地域、年度。
返回数据项：指标ID、指标名称。
●获取指标数据
接口名：statIndexTimeAreaCX
输入数据项：指标ID(多个)、地域(多个)、年度(多个)。
返回数据项：指标ID、指标名称、年度、地域、指标值。
●获取提醒数据
接口名：queryRemindData
输入数据项：用户名。
返回数据项：提醒类型、提醒内容、提醒时间。
第5章提供微信接口
给微信二次开发提供，给微信主要是一些发布的文档。
●获取文档列表接口
接口名：queryDocListData
输入数据项：栏目、最后获取时间。
返回数据项：文档id、文档标题、发布时间。
●获取文档内容
接口名：queryDocContentData
输入数据项：文档id。
返回数据项：文档标题、文档内容、发布人、发布时间。
Web Services业务接口规范说明书
XXXX系统 Web Services业务接口规范说明书 拟制 审核 会签 批准 【公司名称】
版本历史
目录 1.范围 (1) 2.术语、定义和缩略语 (1) 2.1 术语、定义 (1) 2.2 缩略语 (1) 3.接口设计 (1) 3.1 接口公共参数 (1) 3.1.1请求参数 (1) 3.1.2返回参数 (2) 3.2 业务功能接口 (3) 3.2.1业务模块1 (3) 4.MD5加密 (6) 5.参考文献 (6)
1.范围 本规范文档主要适用于XXXX系统和其它业务系统信息数据的接入。 2.术语、定义和缩略语 2.1术语、定义 2.2缩略语 3.接口设计 3.1接口公共参数 接口服务器通过：http://IP:port/EIP/WebService/ 连接服务器，同时对外提供业务功能接口，接收的参数和返回的参数都用一定的xml格式进行封装。 3.1.1请求参数 1.请求类型为String类型
3.请求参数体param定义 参数体param中的具体请求参数，根据不同的业务而不同，详见各业务接口。 3.1.2返回参数 1.返回类型为String类型
接口设计规范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 下载相关的配置文件
项目详细设计说明书
详细设计说明书 当前版本号：1.0 最后更新日期：2011-11-25 作者：员工王 授权人：部门经理
版本记录：
目录 目录 (3) 1引言 (4) 1.1目的 (4) 1.2项目背景 (4) 1.3参考资料 (4) 1.4阅读对象 (4) 1.5术语解释 (4) 2设计概述 (5) 2.1任务 (5) 2.2运行环境概述 (5) 3系统详细设计 (6) 3.1系统总体框架 (6) 3.2功能模块详细设计 (6) 3.3用户界面详细设计 (6) 4存储设计 (7)
1引言 1.1目的 [阐述文档输出：描述本文档对下一环节工作的影响和作用。] 1.2项目背景 [应包括： 项目的委托单位、开发单位和主管部门 该软件系统与其他系统的关系。] 1.3参考资料 [本小节应完整列出此详细设计说明书中其他部分所引用的任何文档。列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： 项目经核准的计划任务书、合同或上级机关的批文； 项目开发计划； 需求规格说明书； 概要设计说明书； 测试计划（初稿）； 用户操作手册（初稿）； 文档所引用的资料、采用的标准或规范。] 1.4阅读对象 [概述本文档的读者、用途。] 1.5术语解释 [必须提供全部需求的术语、缩写词及略语的定义，以便对本文档进行适当的解释。]
2设计概述 2.1任务 [说明详细设计的任务及详细设计所要达到的目标。] 2.2运行环境概述 [对本系统所赖于运行的硬件，包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。]
3系统详细设计 3.1系统总体框架 包含两个图：系统结构图系统运行框架 数据结构的定义 3.2功能模块详细设计 1.函数申明 ,详细说明函数的功能,参数和返回值 2.伪代码 /流程图 如: (1)短消息列表模块 For (i=0; i<短消息的条数; i++) ｛ 打印输出 ｝ 3.3用户界面详细设计 [规定人机界面的内容、界面风格、调用方式等，包括所谓的表单设计、报表设计和用户需要的打印输出等设计。此部分内容可能比较多。]
接口文档规范
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:[
通用接口标准规范v1
接口标准规范 目录 接口标准规范 (1) 第1章概述 (3) 第2章基本要求 (4) 2.1信息通讯安全 (4) 2.1.1 安全评估 (4) 2.1.2 访问控制 (4) 2.1.3 防恶意代码 (4) 2.1.4 加密 (5) 2.2支持高并发 (6) 2.3可监控 (6) 2.3.1 日志全覆盖 (6) 2.4系统资源的动态扩展 (6) 2.5异常处理机制 (7) 2.6业务扩展 (7) 第3章接口通讯方式 (7) 3.1同步请求/应答方式 (7) 3.2异步请求/应答方式 (7) 3.3会话方式 (7) 3.4广播通知方式 (7) 3.5事件订阅方式 (7)
3.7可靠消息传输 (8) 第4章传输控制要求 (8) 4.1负载均衡 (8) 4.2伸缩性与动态配置管理 (8) 4.3网络调度 (9) 4.4充分理由 (9) 4.5单一职责 (9) 4.6高内聚低耦合 (9) 4.7状态及消息 (10) 4.8控制数据量 (10) 4.9禁止随意拓展参数 (10) 第5章接口技术 (10) 第6章接口规范 (11) 6.1域名规范 (11) 6.1.1 http接口 (11) 6.1.2 webservice接口 (11) 6.2 API路径规范 (11) 6.2.1 http接口 (11) 6.2.2 webservice接口 (11) 6.3版本控制规范 (12) 6.3.1 http接口 (12) 6.3.2 webservice接口 (12) 6.4 API命名规范 (12) 6.4.1 新增方法 (13) 6.4.2 删除方法 (13) 6.4.3 修改方法 (13) 6.4.4 获取方法 (13) 6.4.5 获取列表方法 (13)
××-软件项目概要设计说明书(模板)
××_软件项目概要设计说明书 版本： 编制： 审核： 批准： 日182017颁布日期：年4月□非受控受控状态：■受控 分发范围：项目组、财务部、质量管理部I 版软件项目概要设计说明书××_ 本：V0.1 修订记录 修订日版本修订描修订批准
版××_软件项目概要设计说明书本：V0.1 目录 1 引言.............................................................................................................................................................. . (1) 1.1 概述 (1) 1.2 目的 (1) 1.3 范围 (1) 1.4 缩略语 (1) 1.5 术语.................................................................................................................... 错误！未定义书签。 2 参考资料 (2) 3 交付需求列表 (2) 4 系统物理架构 (2) 4.1 系统运行的硬件环境 (2) 4.2 系统运行的软件环境 (3) 4.3 系统运行的网络环境 (3) 4.4 系统部署图 (3) 4.5 安装部署说明 (4) 5 系统逻辑架构 (5)
5.1 子系统 一 (5) 子模块一...................................................................................................................................... 51.1.1子模块二...................................................................................................................................... 51.1.2 5.2 子系统 二 (5) 6 实现视图 (5) 7 进程视图 (6) 8 数据库设计 (6) 9 设计约束 (6) 10 内部接口定义 (6) 11 外部接口 (6) 12 开发环境说明 (7) 13 技术难点 (7) 14 附录.............................................................................................................................................................. .. 8 14.1 模型文件 (8) 14.2 XXXX (8) III _××软件项目概要设计说明书版本：V0.1 ××_软件项目概要设计说明书 1引言 1.1概述 应包括：{ 项目的委托单位、开发单位和主管部门； a. 该软件系统与其他系统的关系。} b.
软件工程-网上商城项目-详细设计说明书
1引言 (2) 编写目的 (2) 背景 (2) 定义 (2) 参考资料 (2) 2程序系统的结构 (2) 3程序1（标识符）设计说明 (2) 程序描述 (3) 功能 (3) 性能 (3) 输人项 (3) 输出项 (3) 算法 (3) 流程逻辑 (3) 接口 (3) 存储分配 (4) 注释设计 (4) 限制条件 (4) 测试计划 (4) 尚未解决的问题 (4) 4程序2（标识符）设计说明 (4)
详细设计说明书 1引言 编写目的 该阶段开发以正式进入软件的实际开发阶段，本阶段完成系统的详细设计并明确系统的数据结构与软件结构。 在软件设计阶段主要是把一个软件需求转化为软件表示的过程，这种表示只是描绘出软件的总的概貌。本详细设计说明书的目的就是进一步细化软件设计阶段得出的软件总体概貌，把它加工成在程序细节上非常接近于源程序的软件表示。 软件开发小组的每一位参与开发成员应该阅读本说明，以清楚产品在技术方面的要求和实现策略，本手册将进行技术评审和技术的可行性检查。 背景 说明： A.软件系统的名称： BS网上商城系统 B.任务提出者： BS电子商务公司 开发者：LEI_SKY软件开发小组 C. 本系统将是一个独立的系统，目前所产生的输出都是独立的 本系统将使用MySql作为数据库的存储系统 定义 A. .B/S（Brower/Server） B. .IIS （Internet Information Server） C. .HTML（Hypertext Markup Language,超文本标记语言） D. .CSS（Cascading Style Sheets,层叠样式表单） E. .JSP（Java Server Pages） 参考资料 相关的文件包括： A. 内部文件《BS网上商城电子商务系统案例研究项目》
软件需求说明书编写规范
{产品名称} 软件需求规格说明书 编写人： 编写日期：年月日
目录 1.产品描述 (3) 1.1.编写目的 (3) 1.2.产品名称 (3) 1.3.名词定义（可选） (3) 2.产品需求概述 (3) 2.1.功能简介 (3) 2.2.运行环境 (3) 2.3.条件与限制（可选） (3) 3.功能需求 (3) 3.1.功能划分（可选） (3) 3.2.功能1 (4) 3.3.功能N (4) 3.4.不支持的功能 (4) 4.数据描述 (4) 5.性能需求（可选） (4) 6.运行需求（可选） (4) 6.1.用户界面 (4) 6.2.硬件接口 (4) 6.3.软件接口 (5) 6.4.通信接口 (5) 7.其它需求（可选） (5) 8.特殊需求（可选） (5) 9.不确定的问题（可选） (5) 10.编写人员及编写日期 (5) 11.附录 (5) 11.1.引用文件 (5) 11.2.参考资料 (5)
1.产品描述 1.1.编写目的 【说明编写本软件需求规格说明书的目的，指出预期的读者。】 1.2.产品名称 【本项目的名称，包括项目的全名、简称、代号、版本号。】 1.3.名词定义（可选） 【对重要的或是具有特殊意义的名词（包括词头和缩写）进行定义，以便读者可以正确地解释软件需求说明。】 2.产品需求概述 2.1.功能简介 【对产品的基本功能做一个简介，包括： 1.本产品的开发意图、应用目标及作用范围。 2．概略介绍了产品所具有的主要功能。可以用列表的方法给出，也可以用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图等。 3．说明本产品与其他相关产品的关系，是独立产品还是一个较大产品的组成部分。 可以用表示外部接口和数据流的系统高层次图，或者方框图说明。】 2.2.运行环境 1.硬件环境： 【详细列出本软件运行时所必须的最低硬件配置、推荐硬件配置(如主机、显示器、外部设备等)以及其它特殊设备。】 2.软件环境： 【如操作系统、网络软件、数据库系统以及其它特殊软件要求。】 2.3.条件与限制（可选） 【说明本软件在实现时所必须满足的条件和所受的限制，并给出相应的原因。 必须满足的条件包括输入数据的范围以及格式。 所受的限制包括软件环境、硬件环境等方面的内容。例如：必须使用或者避免的特定技术、工具、编程语言和数据库；企业策略、政府法规或工业标准；硬件限制，例如定时需求或存储器限制；经费限制、开发期限；项目对外部因素存在的依赖。例如其它项目开发的组件。等等】 3.功能需求 【功能需求描述系统特性，即产品所提供的主要服务。可以通过使用实例、运行模式、用户类、对象类或功能等级等不同方法来描述，还可以把它们组合起来使用。 功能需求的表述形式可以参见《需求分析和管理指南》第8.2节。】 3.1.功能划分（可选） 【此部分从用户的角度描述将软件划分成不同的部分，并给出总体功能结构。对于复杂
接口设计规范
目录 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 概述 (2) 1.1 编写目的 (2) 1.2 参考资料 (2)
项目开发详细设计说明书(超好用实用模板),完整版
实用文案
修订记录
目录 第一章概述 (5) 1.1.应用模块的目的 (5) 1.2.应用模块总体描述 (5) 1.3.应用模块接口描述 (5) 1.4.假设条件 (5) 第二章设计模式（Design pattern） (6) 第三章类设计 (7) 3.1.分块类图 (8) 3.1.1.<类图1> 8 3.1.2.<类图n> 8 3.2.整体继承关系 (8) 3.3.类描述 (9) 3.3.1.<类名1> Class Description 9 3.3.2.<类名n> Class Description 10 第四章交互图 (12) 4.1.<情景编号1: 情景名称> (12) 4.1.1.交互图 12 4.1.2.例外情况及条件 13 4.2.<情景编号n: 情景名称> (13) 第五章状态图 (14) 5.1.<状态图编号1:状态图名称> (14)
5.2.<状态图编号n:状态图名称> (15) 第六章时序流程图 (16) 第七章用户界面设计说明 (18) 7.1.用户界面关系 (18) 7.2.用户界面具体描述 (18) 7.2.1.<界面编号1:界面名称〉 18 7.2.2.<界面编号N:界面名称〉 19 第八章测试考虑 (20) 第九章附录 (21) 9.1.附录A 代码举例 (21) 9.2.附录B 设计问题 (21) 9.2.1.<设计问题1> 21 9.2.2.<设计问题n> 21
第一章概述 1.1.应用模块的目的 请明确客户建立应用模块的目的。 1.2.应用模块总体描述 描述应用模块的总体功能。 1.3.应用模块接口描述 简要描述本应用模块的公共接口，具体接口会在相应的类中进行具体描述。建议采用列表的方式。 1.4.假设条件 列出在问题领域，项目方案及其它影响系统设计的可能方面内，应当成立的假设条件。包括系统的约束条件和应遵循的标准。
完整的接口解决方案说明书
文档编号：T-JKJS 文档版本：0.01 项目编号：XX-DX- PECS 《XX电信工程外部协作系统》 Project Exterior Cooperation System 施工单位接口技术解决方案 编写人：南疯日期：2006-10-30 审核人：日期： 批准人：日期： XXXXXX信息科技股份有限公司 地址：XXXXXXX 邮编：XXXXXX 电话：XXXXXXXX传真：XXXXXX 网站：XXXXXXXXX 修改记录（Revision Chart） 版本号批准人修改人修改0.01南疯2006-10-30 0.02详细修改记录： 序号
1引言 1.1编写目的 1.2覆盖范围 1.3预期读者与阅读建议 1.4文档约定 1.5术语与缩略语 1.6参考文献 2概述 3接口方式 4接口安全 4.1接口认证 4.2数据安全 5事务处理 6性能考虑 7容错处理 8数据格式 8.1约定 8.2施工系统向外协系统发送请求 8.2.1请求查询一个业务数据 8.2.2新增一条记录，得到记录的键值 8.2.3修改一条记录 8.2.4删除一条记录 8.2.5文档上传 8.2.6一条记录中一个文档字段上传多个文件 8.2.7补充上传文档 8.2.8在记录中删除一个文档 8.2.9获得文档的基本信息 8.2.10获得文档的所有兄弟信息 8.2.11获得文档的所有父亲信息 8.2.12下载一个文档 8.2.13获得字典 8.3外协系统向施工系统发送请求 8.3.1发送变更后的数据 8.3.2发送变更后的字典 8.3.3文档发送请求 9信息数据项 9.1数据表 9.2字段信息 9.3字典类型
数据接口规范
登记结算数据接口规范（上市公司版V2.9） 二零一五年一月
版本修订历史
目录 前言 (4) 一、概述 (4) 二、数据文件命名规则 (4) 三、基本数据说明 (4) 第一章发送数据接口规范 (7) 一、中国结算上海分公司向上市公司发送的数据清单 (7) 二、中国结算上海分公司向上市公司发送的数据明细说明 (8) 1)s1(上市公司月中/末大股东名册数据) (8) 2)s1c(上市公司月末大股东名册自助补发数据) (9) 3)s2d（上市公司前N名股东名册自助发送数据） (9) 4)s2e（上市公司权益日全体股东名册自动发送） (10) 5)s3(上市公司红利退款明细数据) (11) 6)s4(人工受理的A股全体股东名册) (12) 7)s5(融资融券和转融通担保证券账户的明细数据) (13) 8)s6(股息红利差异化计税补缴明细数据) (14) 9)s7(全体股票激励期权持有人数据) (16) 10)s8(股票激励期权持有变动明细数据) (16) 11)s9(股票激励期权基本信息数据) (17) 12)s10(A股合并普通账户和信用账户前N名名册) (18)
前言 一、概述 为了进一步规范中国证券登记结算有限责任公司上海分公司（以下简称中国结算上海分公司）与上市公司之间的登记结算数据接口，确保登记结算数据处理的正确性，特编写本登记结算数据接口规范文档。本文主要针对中国结算上海分公司发送和接收的上市公司的各类登记结算数据进行详细的说明。 二、数据文件命名规则 数据文件名: =：前缀 + 标识 + “.” + 后缀 前缀：=：s1|s1c|s2d|s2e|s3|s4|s5|…… 标识：=: 证券代码[yyyymmdd][其它]，其中[yyyymmdd]和[其它]为可选内容，参见各文件的数据库名说明。 后缀：=：mdd m：=：1，2，3，……，9，a，b，c dd：=：01，02，03，……，31 目前中国结算上海分公司发送和接收的数据文件，均采用FOXPRO2.5下的标准DBF格式。为了减少数据通讯量，中国结算上海分公司发送的数据文件都经过ZIP软件压缩后发送至PROP电子信箱中。 发送数据文件的命名规则为：“前缀” + “标识” + “.mdd”；其中mdd表示日期，其中m表示月，（m=1,2,3,…,9,a,b,c），dd表示日。例如2001年12月31日发送的600001上市公司的s1数据的数据名称为“s1600001.c31”。 三、基本数据说明 1、股票的数量单位为“股”、基金的数量单位为“份”；债券、融券数量单位为“一元”面 值数量；金额单位为“元”。 2、证券类别（ZQLB）意义如下： GZ 固定收益类 JJ 基金 PT 无限售流通股 PG 配股 PS 配售股
详细设计说明书书真正例子
详细设计说明书 1.引言 1.1编写目的 本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计，在概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣，在以后想对系统进行扩展和维护的人员。 2. 系统的结构 ●ui：系统界面部分，负责接受用户输入，显示系统输出，负责其他模块功能的协调调用， 并含有站内搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui 部分调用common部分的功能读取xml文件中保存的界面元素属性信息，用户最近访问过的10个ftp信息，用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。 ●client：实现ftp客户端的功能，ftp连接，ftp上传及下载：上传或下载用户指定的
资源，并返回相应的信息。 ●search:资源实时检索部分，根据用户输入的资源名称关键字，资源类型和选择的检索 方式检索用户需要的资源，并验证资源的可用性，返回可用资源及其大小，速度等相关信息。 ●preview：资源预览部分，显示用户选择的资源的部分内容，以使用户决定是否需要该 资源。preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。 3．模块1（ui）设计说明 3.1模块描述 实现用户界面的包，含有11个文件51个类，是本系统中最复杂的代码。 3.2功能 负责接受用户输入，显示系统输出，其他模块功能的协调调用，并含有站内搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。 3.3交互的模块 client，search，preview，common。 3.4 模块设计 该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下： ●MainFrame.java：MainFrame是含有主函数的类，也是lyra客户端开始执行的类， 它先后进行资源的初始化，显示主界面等工作，根据屏幕大小设置界面大小，设置界面的观感。 ●FtpFrame_AboutBox.java:显示关于窗口的类，当用户点击帮助菜单中的关于菜单 项时会弹出关于对话框。 ●Tools.java：FileTools是文件操作辅助类，可以实现文件的递归删除等。 ●XMLController.java: JDOMTes是操作xml文件的类，用JDOM来操作xml文件， 实现的功能有： （1）保存ftp服务器的文件列表（站内搜索时使用），递归的从ftp服务器读取列表，并存入一个xml文件中（文件的命名方法是：ip+用户名.xml）;以目录树的形式保存。 （2）根据文件名在文件中查找文件，站内搜索时使用。 （3）保存ftp服务器的信息：ip，端口（默认端口21不保存），用户名（默认anonymous 不保存），密码，最多存10个；存在resource\settings\ serversinfor.xml文件中。 （4）读取已存储的ftp服务器信息。 （5）从type.xml读取搜索的类型。 ●Constants.java:放置系统运行时使用的一些常量，initcontent（）函数对所有常量 进行初始化，这个函数在MainFrame中被调用一次。iconHashMap是hash表，用于存放文件的系统图标。 ●CustomizedController.java：包含自定义的控件类，java中的控件可能不能满足需求， 需要自己定义某些属性。这些控件会在创建界面时使用。其中含有的类有： （1）CustomizedJTable 是表格类，设置表格的某些属性，如字体等。 （2）CustomizedTableCellRenderer是表格单元格绘制器类，主要用于显示文件的系统图标，和文件名。 （3）LeftPanel类的父类是JTabbedPane，用户显示主窗口左边的面板。 （4）RightPanel类的父类是JPanel，用户显示右边的主题部分，包括右上边的搜索及服务
API接口设计说明书
XXAPI 接口设计说明书 公司 2016年11月25日 文档管理信息表 主题XX api接口设计说明书 版本V0.1 内容 关键字 参考文档 创建时间 创建人 最新发布日期 文档变更记录表 修改人修改时间修改内容 创建
目录 文档变更记录表 .................................................................................................................................................................................. 目录 .................................................................................................................................................................................................... 引言 ...................................................................................................................................................................................................... 编写目的 背景 定义 参考资料 综述 ...................................................................................................................................................................................................... 统一的输入输出参数 必须登录才能访问的接口 错误返回码列表 用户接口 .............................................................................................................................................................................................. 用户注册（user/signup） 用户登录（user/signin） 优惠券接口 .......................................................................................................................................................................................... 我的优惠券（coupon/mycoupon）
swagger接口规范说明
1.bean对象中添加注解 1.1 class上添加注解@ApiModel 1.2 属性上添加注解@ApiModelProperty(value = "姓名", example = "name")，属性是属于 对象关联属性则不需要添加example。 事例： 2.controller中添加注解 2.1 class上添加注解@Api(description = " swagger事例")。Description可以描述这个 controller是用来做什么的，@ApiIgnore：在class上是过滤掉这个controller不让这个类下面的接口在前端显示，在方法上让这个接口不在前端显示 @RequestMapping(value = "/testObject",method = RequestMethod.POST) Method统一为RequestMethod.POST 2.2 方法上添加注解 2.2.1 @ApiOperation(value = "test",notes = "test",produces = "application/json") 说明： value：方法名 notes:方法描述 produces：相应格式（统一为application/json） 2.2.2 @ApiImplicitParams({ @ApiImplicitParam(name = "subcategoryId", value = "年级iD", required = true, paramType = "query", dataType = "string") }) 说明：参数传入每一个@ApiImplicitParam表示一个参数 name:参数名，通过request.getParameter("name").的名字 value:说明 required：是否必填，true:必填，false：不必填 paramType：参数获取类型（统一使用query） dataType：数据类型
项目设计说明书
项目设计说明书 丙烯和氨气的利用 ——15万吨丙烯腈的合成 安徽工业大学
第一章项目总论 1.1 项目概况 1.2 项目设计依据、标准及原则 1. 2.1 项目设计依据 1.2.2 项目使用的专业标准规范 1.2.3 项目设计原则 1.3 产品及原料方案 1.4 厂址概况 1.5 项目意义 第二章总图运输 2.1 厂址选择 2.1.1 设计原则 2.1.2 厂址概况 2.1.3 区位优势 2.2 厂区布置 2.2.1 编制依据 2.2.2 平面布置的一般原则 2.2.3 厂区总平面布置综述 2.2.4 厂区布置的理念 2.2.5 厂区布置与规划 第三章工艺说明 3.1 设计目标
3.2 工艺路线分析 3.2.1 丁二烯抽提工艺 3.2.2 MTBE合成单元工艺 3.2.3 MTBE合成和裂解联合工艺 3.3 工艺流程说明 3.3.1 工艺流程概述 3.3.2 丁二烯抽提工段 3.3.3 MTBE合成段及精制工段 （8） .......................................................... 42 4361.23ln=-9.24416+aKT 错误！不能通过编辑域代码创建对象。（9） 42 （10） (42) 6-49599=7.06810exp kRT × . . （12） (42) 6+10-2-49599-7.06810exp-85858.266-=-7.31110exp IBIBMeOHMTBEIBMeOH arRTaarRTa . .=×× . . . . . .××× . . . . 3.3.4 MTBE裂解段及异丁烯分离工段 (44) 3.4 模拟过程 3.4.1 模拟模块的选择和物性方法的选用 3.4.2 模拟流程中的化学反应及动力学 3.4.3 模拟参数的优化（16） (54) ()[]21iCKMEOHC=?.
软件项目详细设计说明书
中国广东核电集团 CHINA GUANGDONG NUCLEAR POWER GROUP 记录文件 项目编号 项目名称 CGN-IT-C3-A01-01 软件项目章程 版本编写审核审定批准生效时间A/0 注：如无受控文件标识（蓝色印章）则为非有效版本，以受控文件规定为准。
修改记录页
为具体内容，或删除。文件提交时不得再含有这些内容。】
目录 1 引言 (5) 1.1 编写目的 (5) 1.2 背景 (5) 1.3 术语与缩写解释 (5) 1.4 参考资料 (5) 2 模块命名规则 (6) 3 程序系统的组织结构 (6) 3.1 子系统划分 (6) 3.2 模块划分 (6) 3.3 程序与功能需求、系统模块间的关系 (6) 4 程序1（标识符）设计说明 (6) 4.1 程序描述 (7) 4.2 功能 (7) 4.3 性能 (7) 4.4 输人项 (7) 4.5 输出项 (7) 4.6 算法 (8) 4.7 流程逻辑 (8) 4.8 接口 (8) 4.9 存储分配 (8) 4.10 注释设计 (8) 4.11 限制条件 (9) 4.12 尚未解决的问题 (9) 5 程序2（标识符）设计说明 (9)
1引言 1.1编写目的 【给出项目详细设计说明书的编写目的，同时指明读者对象。】 1.2背景 【说明： a．待开发软件系统的名称； b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。】 1.3术语与缩写解释 【列出本文件中用到的专门术语的定义和外文首字母缩写的原词组。】 1.4参考资料 【提示：可包括：（1）本项目经核准的计划任务书、需求规格说明书、合同、项目设计概要说明书或上级机关的批文；（2）本文档所引用的资料、规范等，列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。】
接口文档规范
XXX接口说明书 (版本： 文档编号保密等级 作者最后修改日期 审核人最后审批日期 批准人最后批准日期
修订记录 日期版本修订说明修订人
1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如： 结构：data（数据）、errorCode（状态码）、msg（提示信息） { data:{}, .] 订单列表 orderList orderId string 否订单id orderName string 否订单名称
isStudent boolean 是false false 是否学生（是：true，否： false） 返回参数： 参数名类型示例值默认值描述 data array […]返回的数据 data id string 用户id gender number 1 1 用户性别（男：1，女：2）invoiceTitle string 抬头 address string 地址 billList array [...] 订单列表数据 billList id string 订单id billName string 订单名称 billStauts number 1 1 订单状态（待开票：1，回款： 2，核销：3） address string 客户地址 userInfo object {} 用户信息 userInfo name name 用户姓名 age number 用户年龄 gender string 1 1 用户性别（男：1，女：2）errorCode number 状态信息 msg string 信息提示 返回示例值: { data:[ { id:'1', gender:2, invoiceTitle:'帝国快运', address:'陕西省西安市雁塔区科技路24号', billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' }, { id:'002', billName:'测试数据02',
项目设计说明
《项目名称》－－设计说明小组名称： 设计说明 目录 1 概述 (1) 1.1 编写目的 (1) 1.2 参考资料 (1) 1.3 术语和缩写词* (1) 2 需求概述 (1) 3 结构设计 (1) 3.1 总体设计 (1) 3.2 接口设计* (1) 3.3 数据结构设计 (1) 3.3.1 公共数据结构设计 (1) 3.3.2 数据库设计 (1) 3.3.3 数据结构同程序的关系* (1) 3.4 出错处理设计* (2) 3.5 其它* (2) 4 模块详细设计 (2) 4.1 模块1设计 (2) 4.1.1 功能说明 (2) 4.1.2 算法 (2) 4.1.3 输入 (2) 4.1.4 输出 (2) 4.2 模块2设计 (2) 5 用户界面设计 (2) 【注】本编写指南中带有“*”标志的表示可选部分，即在文档编写过程中可以依据实际项目的具体情况进行取舍，文档完成后这些“*”标记应该去掉。
1 概述 1.1 编写目的 本文档的编写目的是：详细定义×××××软件的总体功能；给出系统的结构设计和过程设计，作为程序编写的依据。 1.2 参考资料 包括： a. 项目来源； b. 本文档中引用到的规范和资料等； c. 列出这些规范和资料的作者、编号、标题、发表日期、出版单位或资料来源。 1.3 术语和缩写词* 列出本文档中用到的专门术语的定义和缩写词，缩写词要给出中文译名和英文全称，常用的不需要定义。 2 需求概述 概述系统的特性和需求，扩充软件需求说明中的信息，给出增加的细节，详尽地指出对软件需求说明中有关特性和需求作出的变更。（详细说明见《需求说明》）。 3 结构设计 3.1 总体设计 绘制软件模块结构图（Software Chart）。 对系统总体结构设计和所绘制图形加以文字说明。 3.2 接口设计* 对和硬件或其它外部系统的接口进行说明。 3.3 数据结构设计 3.3.1 公共数据结构设计 对程序当中所定义的全局变量、全局数据结构或类当中Public数据结构进行定义和说明。 3.3.2 数据库设计 对程序当中所采用的数据库相关的名称和标识符、在数据库当中的位置、定义、度量单位、格式和值域、敏感程度、数据项名、缩写词和代码，包括用于数据库的规格说明等进行定义。建议给出数据库表结构。 3.3.3 数据结构同程序的关系* 数据结构影响最后的构件（模块）过程设计。因此，需要说明数据结构如何影响程序的数据组织、存取方式、结合程度和处理方法。