OpenLayers API
由于OpenLayers是采用JavaScript实现的，不存在包的概念，但是它可以通过命名空间来实现类似包的功能。另外，JavaScript不存在继承的概念，也不存在私有、公有、保护等概念，OpenLayers中所谓的继承其实就是将基类中的所有属性和方法复制到子类中去。OpenLayers的命名空间如下：
一、OpenLayers命名空间：
如上图所示，OpenLayers是整个webgis系统的最外层命名空间，所有的地理信息系统相关web程序都在此命名空间下，在此命名空间下又创建了其他的命名空间来管理相关功能的类。在这个命名空间下定义了一些基础类和基类来构建整个框架。
1、class OpenLayers.Map
Map类将div DOM元素实例化的对象为地图容器，可以向地图容器中添加图层和控件。
属性
2、class OpenLayers.Map2
基于OpenLayers.Map封装，将自有地图图层和常用控件都已经加载在地图当中，用户无需关心地图数据源等问题，简化了用户的地图调用。实例化该类后即可创建一个可查看和使用的地图对象，其方法和属性与OpenLayers.Map一致，见OpenLayers.Map类。
2、class OpenLayers.Marker
OpenLayers命名空间下的Marker类可以被实例化为marker对象，用于标注地图上的位置，marker对象是由LonLat 对象和Icon对象组合而成的。markers一般被添加到一个叫做https://www.doczj.com/doc/5211395644.html,yer.Markers的特殊图层中。
需要注意的是，如果你在一个marker中使用了一个icon，也就是说，你不能在其他的marker中在使用它——一旦你使用了这个icon，你应该clone()这个icon然后在另外的marker中使用这个icon。
3、class OpenLayers.Popup
Popup类实例化一个弹出窗口，通常被添加到地图容器中。
构造函数
4、class OpenLayers.Icon
Icon为图标类，图标指定用来在地图上显示Marker 的图像。
5、class OpenLayers.Format
各种format类的基类，它的子类实现reading/writing方法。构造函数
属性
方法
6、OpenLayers.Request
OpenLayers.Request命名空间下包含两个常用的AJAX方法，通过这两个方法可以方便的实现XMLHttpRequests功能。方法
7、class OpenLayers.Feature
Feature是几何信息和属性的结合体，在OpenLayers.Feauter中主要是包括一个标记和经纬度。
方法
二、BaseType命名空间:
在BaseTypes命名空间下定义了一些基本类型的类，如LonLat、Size等。
1、class OpenLayers.LonLat
LonLat是以经度和纬度表示的地理坐标点。
注意：进行地图投影时通常将经度与地图的x 坐标联系起来，将纬度与y 坐标联系起来。构造函数
2、class OpenLayers.Pixel
Pixel是以像素坐标表示的地图上的一点。在地图坐标系统中，x坐标向右增大，y坐标向下增大。
属性
方法
3、class OpenLayers.Size
Size是地图矩形区域的大小（以像素表示）。大小对象有两个参数：width 和height。宽度是点的x 坐标的差值，高度是y 坐标的差值。
构造函数
属性
方法
三、Control命名空间：
OpenLayers命名空间下面定义了Control基类，Control命名空间下面的所有类都继承于Control基类。每个具体的控件类实现地图的一项具体操作。控件影响地图的显示和行为，它允许拖动和放大缩小地图以控制地图的比例尺，默认的控件是被添加到地图上的，尽管如此，也可以通过传递可选参数将其加入到地图外部的DIV中。
1、class BM.Control.TMeasureDistance
TMeasureDistance为测距控件，它实现OpenLayers.Control接口，因此可用OpenLayers.map.addControl()方法添加到地图中。可能会增加控件定位的参数或方法
2、class BM.Control.TMeasurePolygon
TMeasurePolygon为测面积控件，它实现OpenLayers.Control接口，因此可用OpenLayers.Map.addControl()方法添加到地图中。可能会增加控件定位的参数或方法
3、class BM.Control.TPanZoomBar
PanZoomBar为缩放移动控件，继承于OpenLayers中的PanZoomBar，主要工作为修改样式，使图标跟以前GZGIS中对应的控件一样，增加设置最大级别和最小级别的功能,它实现了OpenLayers.Control接口，因此可用OpenLayers.Map.addControl()方法添加到地图中。
4、class BM.Control.TOverviewMap
OverviewMap为缩略图控件（鹰眼控件），可继承于OpenLayers中的OverviewMap，主要工作为修改样式，由于OpenLayers.OverviewMap实现了OpenLayers.Control接口，因此可用OpenLayers.Map.addControl()方法添加到地图中。
构造函数
5、class BM.Control.TNavigation
TNavigation为导航控件，该控件将分类导航,一个导航控件中包含一到多个TNavPage实例。该控件实现了OpenLayers.Control接口，可由OpenLayers.Map.addControl()方法加载到地图中。
方法
6、class BM.Control.TGoto
TGoto为定位控件，根据用户输入的经纬度定位地图。
//调用事例
//1、不设置标题
//map.addControl(new BM.Control.TGoTo());
//2、设置标题
//var gotoControl = new BM.Control.TGoTo();
//gotoControl.setTitle("标题");
//map.addControl(gotoControl);
方法
7、class BM.Control.TDivTree
TDivTree为复选框树行控件，被添加到DOM元素中，无需实现OpenLayers.Control接口，与地图无关。
8、class BM.Control.TTree
TTree为复选框树的数据结构，可以获得数组形式的所有节点和树形式的所有节点，可以获得包含自己的树对象。不需用户进行实例化，TDivTree自动调用。
9、class BM.Control.TTreeNode
TTreeNode为复选框节点类。
四、Feature命名空间：
特征元素是几何信息（geometry）和地理信息（attribute）的结合体，从类结构来看它实际上是marke类和lonlat 类的组合。
1、class OpenLayers.Feature.Vector
Vector类使用OpenLayers.Geometry类描述其几何特征，它有一个数据对象的attributes属性，和一个style属性，默认的style属性在
构造函数
五、Format命名空间：
Format命名空间下定义了一系列的解析器用于将特征元素格式化为具体格式的标准数据，然后利用格式化后的标准数据与采用此标准实现的服务器端交互。例如，WFS请求过程中，客户端和服务器端统一采用GML格式的数据进行交互，所以客户端用Format命名空间下的GML类将具体的特征元素格式化为GML数据发送到服务器端或将服务器端传送过来的GML数据解析为特征元素显示在地图上。Format命名空间下的类都继承了format基类，重写了它的read/write方法。
1、class OpenLayers.Format.XML
解析XML数据的类，继承于OpenLayers.Format类。参考openlayers/XML example.htm例子。
六、Geometry命名空间：
Geometry是对地理学对象的描述，此命名空间下的类都继承了OpenLayers命名空间下的Geometry基类，具体子类描述了各种具体的地理学对象，例如Point、Line、Polygon分别描述了能用点、线、面指代的具体地理学对象。
1、class OpenLayers.Geometry
所有具体geometry对象的基类，Geometry命名空间下面的所有类都直接或间接的继承了Geometry类，所有具体能够实例化的类定义了所有geometry对象都应该有的属性和方法。
2、class OpenLayers.Geometry.Rectangle
矩形几何对象，继承于Geometry基类。(暂不支持)
属性
方法
3、class OpenLayers.Geometry.Point
点的几何对象，继承于Geometry基类。构造函数
方法
4、class OpenLayers.Geometry.Collection
该集合类继承了Geometry类。OpenLayers中的多点、多线线、、面、多面其实是点的集合，继承了该集合类，使其既继承了Geometry的属性和方法，又具备了Collection类的属性和方法。
集合，顾名思义就是一系列Geometry对象的集合，这些Geometry对象存储在集合对象的components属性中，components属性可以作为参数传递给集合的构造函数。当新的Geometry对象被加入到集合中时并不是加入它的副本。当从集合中移除Geometry对象需要该集合对象的引用。
集合对象中的getArea()方法和getLength()方法只不过是对集合对象中的所有Geometry对象各自的距离和面积求和。
构造函数
5、class OpenLayers.Geometry.MultiPoint
多点是点的集合对象，MultiPoint继承于Collection类。下面的属性和方法只列出重写的部分，其他的请参考父类。构造函数
属性
6、class OpenLayers.Geometry.Curve
Curve(曲线)类继承于MultiPoint类，它的点被看做是连接的，提供的getLength()方法是相连两点间的距离的累加。
方法
线类继承于曲线类，一旦添加了两个点，就不能再少于两个点。（线至少有两个点）
构造函数
方法
8、class OpenLayers.Geometry.LinearRing
LinearRing是特殊的LineString,它是闭合的，当加入一个新的点的时候它会自动的闭合，不用你去与第一个点连接。LinearRing继承于LineString。
属性
方法
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系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。
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范围 (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．用方框图来表达不同的功能和它们的关系也是有帮助的。但应牢记，这样的图不是产品设计时所需求的，而只是一种有效的解释性的工具。 例如：高层的数据流图，面向对象的分析等。
目录 三、需求规格说明书 (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人工处理过程
XXXX公司接口协议说明书接口协议说明书 受控状态： 发放号： 2017-07-13发布2017-07-13实施
版权说明
修订页
目录 通信协议说明书 (1) 目录 (4) 1引言 (5) 1.1Restful介绍 (5) 2中心服务器与播放控制器间通信协议 (5) 2.1概述 (5) 2.2用户管理 (5) 2.2.1登录 (5)
1引言 1.1Restful介绍 REpresentational State Transfer (REST) 是一种架构原则，其中将web 服务视为资源，可以由其URL 唯一标识。RESTful Web 服务的关键特点是明确使用HTTP 方法来表示不同的操作的调用。REST 的基本设计原则对典型CRUD 操作使用HTTP 协议方法：POST - 创建资源GET - 检索资源PUT –更新资源DELETE - 删除资源. REST 服务的主要优势在于：它们是跨平台(Java、.net、PHP 等）高度可重用的，因为它们都依赖基本HTTP 协议。它们使用基本的XML/JSON，而不是复杂的SOAP XML，使用非常方便。 2中心服务器与播放控制器间通信协议 2.1概述 云平台中心服务器与播放控制器间的通信采用restful通信协议框架，云平台作为restful服务器，播放控制器作为restful客户端。 登录 2.2用户管理 2.2.1登录 2.2.1.1请求API POST /api/v1/login 2.2.1.2请求参数描述 2.2.1.3请求参数示例 { "account": "admin", "password": "md5(admin)" }
竭诚为您提供优质文档/双击可除java开发接口文档模板 篇一：java的接口与实例 一、定义 java接口（interface），是一系列方法的声明，是一些方法特征的集合，一个接口只有方法的特征没有方法的实现，因此这些方法可以在不同的地方被不同的类实现，而这些实现可以具有不同的行为（功能）。 接口定义的一般形式为： [访问控制符]interface{ 类型标识符final符号常量名n=常数； 返回值类型方法名([参数列表]); … } 二、接口的特点 1、java接口中的成员变量默认都是 public,static,final类型的(都可省略),必须被显示初始化,即接口中的成员变量为常量(大写,单词之间用"_"分隔) 2、java接口中的方法默认都是public,abstract类型
的(都可省略),没有方法体,不能被实例化 3、java接口中只能包含public,static,final类型的成员变量和public,abstract类型的成员方法 4、接口中没有构造方法,不能被实例化 5、一个接口不能实现(implements)另一个接口,但它可以继承多个其它的接口 6、java接口必须通过类来实现它的抽象方法 7、当类实现了某个java接口时,它必须实现接口中的所有抽象方法,否则这个类必须声明为抽象类 8、不允许创建接口的实例(实例化),但允许定义接口类型的引用变量,该引用变量引用实现了这个接口的类的实例 9、一个类只能继承一个直接的父类,但可以实现多个接口,间接的实现了多继承. 三、接口的用法 1、精简程序结构，免除重复定义 比如，有两个及上的的类拥有相同的方法，但是实现功能不一样，就可以定义一个接口，将这个方法提炼出来，在需要使用该方法的类中去实现，就免除了多个类定义系统方法的麻烦。举例：鸟类和昆虫类都具有飞行的功能，这个功能是相同的，但是其它功能是不同的，在程序实现的过程中，就可以定义一个接口，专门描述飞行。 下图是分别定义鸟类和昆虫类，其都有飞行的方法。
客户化开发需求规格说明书 媒讯集团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来生成客户端代理。
XXX项目接口文档 版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/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,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}
2文件上传 2.1文件上传（ajax） 请求地址：/session/file/upload formData.append("file", this.files[0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = JSON.parse(result); if(result.code == "10000"){ layer.msg('上传成功！'); $("#editHeadPortrait").val(result.returnValue.filePath); } } }); 响应例子：returnValue里包含了 fileName和filePath 3字段管理-所属类型 3.1新增所属类型 请求地址：/session/fieldType/save
X X X项目接口文档版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/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,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传
2.1文件上传（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"){ ('上传成功！'); } } });
接口协议说明书 受控状态： 发放号： 2017-07-13发布2017-07-13实施
版权说明
修订页
目录 通信协议说明书 (1) 目录 (4) 1引言 (5) 1.1Restful介绍 (5) 2中心服务器与播放控制器间通信协议 (5) 2.1概述 (5) 2.2用户管理 (5) 2.2.1登录 (5)
1引言 1.1Restful介绍 REpresentational State Transfer (REST) 是一种架构原则，其中将web 服务视为资源，可以由其URL 唯一标识。RESTful Web 服务的关键特点是明确使用HTTP 方法来表示不同的操作的调用。REST 的基本设计原则对典型CRUD 操作使用HTTP 协议方法：POST - 创建资源GET - 检索资源PUT –更新资源DELETE - 删除资源. REST 服务的主要优势在于：它们是跨平台(Java、.net、PHP 等）高度可重用的，因为它们都依赖基本HTTP 协议。它们使用基本的XML/JSON，而不是复杂的SOAP XML，使用非常方便。 2中心服务器与播放控制器间通信协议 2.1概述 云平台中心服务器与播放控制器间的通信采用restful通信协议框架，云平台作为restful服务器，播放控制器作为restful客户端。 登录 2.2用户管理 2.2.1登录 2.2.1.1请求API POST /api/v1/login 2.2.1.2请求参数描述 2.2.1.3请求参数示例 { "account": "admin", "password": "md5(admin)" } 2.2.1.4回应状态码
1 引言 1．1编写目的 说明编写这份详细设计说明书的目的，指出预期的读者。 1．2背景 说明：a．待开发软件系统的名称 ；b．本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。 1．3定义 列出本文件中用到专门术语的定义和 外文首字母组词的原词组。 1．4参考资料 列出有关的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的 批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些 文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。 2 程序系统的结构 用一系列图表列出本程序系 统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。
3 程序 1（标识符）设计说明从本章 开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块，尤其是层次比 较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明 这一点即可。 3．1程序描述 给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点 （如是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发处理卜…．．等 ）。 3．2功能 说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。 3．3性能 说明对该程序的全部性 能要求，包括对精度、灵活性和时间特性的要求。 3．4输人项 给出对每一个输入项的特性，包括名称、标识、数据的类型和格 式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。 3．5输出项 给出对每
媒讯集团 EAS 项目 CTC与 EAS接口需求及设计说明书 文档作者： 创建日期：2013-05-10 确认日期： 当前版本： 拷贝数量：1 审批签字: 客户方： 实施方：
文档控制 修改记录 日期作者版本参考版本备注
目录 1.概述错误 !未定义书签。 读者错误 ! 未定义书签。 图例错误 ! 未定义书签。 目的错误 ! 未定义书签。 二、业务现状错误 !未定义书签。 三、概要设计错误 !未定义书签。 接口通讯方式错误 !未定义书签。 通讯内容定义错误 !未定义书签。 媒讯 CTC系统提供接口使用范例错误!未定义书签。 金蝶 EAS提供接口使用范例错误!未定义书签。 媒讯 CTC系统提供接口服务地址错误!未定义书签。 金蝶 EAS提供接口服务地址错误!未定义书签。 接口需求错误!未定义书签。 四、详细设计错误 !未定义书签。 EAS接口错误!未定义书签。 概述 金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。读者 本文读者对象为业务管理人员、系统设计、开发人员、测试人员。
图例 本文中如未进行特殊说明，各图标代表的含义如下： 表示一个活动； 表示动态的业务数据，如系统单据； 表示流程走向； 表示条件判断、流程分支； 表示静态的业务数据，如基础资料； 表示系统外一个手工处理活动； 表示系统外手工填制的单据； 表示当前系统之外的活动； 表示当前系统之外产生的业务数据。 目的 本文档是媒讯 CTC系统与 EAS 系统接口的需求及设计方案相关文档，可用于指导开发、测试工作和作为验 收相关依据文档。 二、业务现状 待补充 三、概要设计 接口通讯方式 金蝶 EAS与媒讯 CTC系统之间通讯采用WebService方式进行数据传输。 通讯内容定义 对于记录型的大对象，在通讯时，采用 String 型的 xml 格式的参数进行传递。对于其他非记录型的对象，在通讯时，可采用非xml 格式的参数进行传递，也可使用多个参数。具体格式，请参照每个接口的通讯用例说明。 媒讯 CTC系统提供接口使用范例 待补充。
XXX项目APP接口文档 首页 (3) 首页 (3) 加载更多商品 (7) 用户注册 (9) 注册 (9) 发送手机验证码 (11) 用户中心 (12) 登录 (12) 登出 (14) 原产品 (15) 产品列表 (15) 产品详情 (18) 分类树 (22) 备注： (23)
注： 传参一律用post方式，key=request, value为一串json格式字符串，格式如： request={ "head": { "partner": "xxxxxxxxxxxxxxxxxxxxxxx", "key": "xxxxxxxxx", "mdkey": "xxxxxxxxxxx" }, "para": { "user_name": "user_name", "pwd": "123456" }, "result": { "start": 0, "count": 10 } } head：头信息，用于安全校验，参数固定为partner、key、mdkey 三项，mdkey随不同接口而变，partner和key为常量头部信息校验错误统一返回，错误码分三种： 1：PARTNER有误 { "head": { "code": "C0004", "msg": "PARTNER验证失败！" } } 2：KEY有误 { "head": { "code": "C0005", "msg": "KEY验证失败！" } } 3：MD5加密错误 { "head": { "code": "C0001", "msg": "请求验证失败！" } } para：请求体，客户端请求所需要传入的参数，依据不同接口而定 result：结果集，主要用于分页
XXX项目接口文档版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/session/field/findAll 请求参数 响应
请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconCo lour":"","iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5 ,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传 2.1文件上传（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 3字段管理-所属类型 3.1新增所属类型 请求地址：/session/fieldType/save 请求参数 响应
《五．详细设计说明书》 1、引言： 1、1编写目的： 在前一阶段（概要设计说明书）中，已解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息，以及数据结构、模块结构的设计等。在以下的详细设计报告中将对在本阶段中对系统所做的所有详细设计进行说明。 在本阶段中，确定应该如何具体地实现所要求的系统，从而在编码阶段可以把这个描述直接翻译成用具体的程序语言书写的程序。主要的工作有：根据在《需求分析说明书》中所描述的数据、功能、运行、性能需求，并依照《概要设计说明书》所确定的处理流程、总体结构和模块外部设计，设计软件系统的结构设计、逐个模块的程序描述（包括各模块的功能、性能、输入、输出、算法、程序逻辑、接口等等），解决如何 1．接受：旅客信息及取票通知和帐单； 2．输出：取票通知和帐单及机票； 3．网络输出和加密，输入和解密； 4．分辨信息的种类并采取相应的处理步骤； 5．判断信息的正误并采取相应的处理步骤； 6．进行数据库的查询、修改工作； 7．接受并判断错误，输出相应的出错消息； 在以下的各个阶段中，《用户操作手册》将与本阶段的工作紧密结合，努力作到让用户易懂易学。《测试报告》和《维护报告》也将参考本说明书，检验本系统的各项性能指标，及时发现纰漏及时修补，一定要把功能强大、稳定可靠、便于维护的机票预定系统交到用户手中。 1、2项目背景： 本项目（机票预定系统）时由浙江航空公司委托，由《》软件开发小组负责开发。 本机票预定系统项目主要由两部分形成： 1、各旅行社中的前台客户程序； 2、航空公司中的数据库服务器程序；
支付网关说明文档by:Q294500001 目录 ##联盟支付网关说明文档..................................................................... 错误！未定义书签。目录 .. (1) 第一章文档描述........................................................................................... 错误！未定义书签。 1、文档说明 (1) 2、阅读对象 (1) 第二章系统原理 (2) 1、术语定义 (2) 2、消费流程 (2) 3、查询流程 (2) 4、系统加密 (2) 第三章网银接口定义 (3) 1、同步过程接口定义（商户系统发起请求） (3) 2、下行异步通知过程接口定义（##联盟接口发起请求） (5) 3、下行同步通知过程接口定义（##联盟接口发起请求） (7) 第四章查询流程接口定义 (8) 第五章订单外部查询独立网址................................................................... 错误！未定义书签。附录1：##联盟支付网关银行类型说明. (9) 第一章文档描述 1、文档说明 本说明文档用于指导##联盟商户实现与##联盟网银接口的顺利对接。请相关技术人员详细阅读本文档。 2、阅读对象 商户开发人员。
第二章系统原理 1、术语定义 商户：指已独立拥有在线销售系统，并成为##联盟网银接口系统会员，且已使用或者将使用##联盟网银接口实现收付费或其他相关功能需求的企业或者个人。 外部接入接口：指##联盟通过统一的方式接受外部请求的接口。 商户系统：指使用##联盟外部接入接口的计算机系统，一般指商户所拥有的在线销售系统。 用户：指在商户系统内进行消费的企业或者个人。 商户ID：指##联盟为使用外部接入接口的商户统一分配的唯一标识。 商户密钥：指商户在和##联盟确定合作意向时##联盟为商户提供的16位字符串。该信息作为商户系统和##联盟交互时身份确认的依据，需商户妥善保管。 2、消费流程 通常，一次支付最少包括2个交互过程。第一个过程是商户系统将在线支付等信息提交到##联盟接口的过程，称之为上行过程。第二个过程是在支付完成后，##联盟接口通过server to server方式将支付结果告知商户系统的过程，称之为下行异步通知过程。 如果用户在跳转到##联盟接口完成支付操作后，需要##联盟接口将处理结果立即返回给商户系统的下一步页面，让用户继续完成整个操作流程，此时支付还应包括第三个流程，下行同步通知过程。该过程需要在上行过程中提交参数hrefbackurl。 3、查询流程 在商户系统将订单成功提交给##联盟接口后的任意时间，商户系统可发起请求查询订单的处理结果。该流程由商户系统发起，由接口返回相应结果。 4、系统加密 ##联盟接口采用MD5加密方式对传输数据进行签名验证，具体请参考相关接口定义。对MD5加密后的签名值，请注意结果的大小写务必正确。 为了确保签名值不是因为MD5加密算法而导致结果不正确，请各商户在调用接口前对字符串1234567890abcdefghijklmnoprstuvwxyz使用MD5加密算法进行加密，若加密结果为
项目案例名称：《软件系统》 项目案例文档：《软件系统概要设计说明书》 1. 导言 1.1 目的 本文档的目的是描述《软件系统》项目的详细设计，其主要内容包括： -系统功能简介 -系统详细设计简述 -各个模块的三层划分 -最小模块组件的伪代码 本文档的预期的读者是： ●设计人员 ●开发人员 ●项目管理人员 ●测试人员 1.2 范围 该文档定义了系统的各个模块和模块接口，但未确定单元的具体实现，这部分内容将在实现中确定。 1.3引用标准 [1] 《企业文档格式标准》 V1.1 北京长江软件有限公司 [2] 《软件详细设计报告格式标准》 V1.1 北京长江软件有限公司软件工程过程化组织 1.4 参考资料 [1] 《实战ｓｔｒｕｃｔ》〔美〕ＴｅｄＨｕｓｔｅｄ 机械工业出版社 1.5 版本更新信息 本文档版本更新记录如表C-1： 表C-1：版本更新记录 2 系统设计概述 根据《软件系统》的概要设计，系统分为用户登录管理、帐号管理、帐号组权限管理、角色管理、日志查询、统计报表、平台管理、业务信息系统维护、个人信息维护等模块，他
们的关系如图C-1，以下将分小节对各个部分分别进行详细设计。 图C-1：模块设计图 3 详细设计概述 由于本系统采用了基于Struts体系结构的设计，即采用MVC的三层设计模式，采用面向对象的JAVA语言以及JSP的脚本语言。所以，基本采用面向对象的设计方法。在整个的开发过程中，尽可能采用复用的原则，例如采用标签库，统一数据库的基本操作，统一结果显示等。 本文档的详细设计主要是按照Struts的MVC的三个层次分别描述视图层、控制层和模型层模块的伪代码。为下一步的编码提供基础。 ４登录管理模块 登录管理模块负责用户的登录。系统框架可以分成三层结构，即视图层、控制层和模型层，具体如表C-2所示。 表C-2：登录管理的三层模块 4.1视图层 根据上述的功能介绍，视图页面设计如表C-3所示。 表C-3：登录管理模块页面设计