展示专区数据对接接口说明文档
接口地址：https://www.360docs.net/doc/ed4745657.html,/services/jobService?wsdl
方法命名空间：http://com.jobwap.talent.dao
批量上传的方法：batchInsertWeb
逐条上传的方法：batchInsertWeb2
batchInsertWeb方法所需要传递的参数：
1.List
String数组长度为16,分别代替了所有上传的信息.
依次是Ecel表里面的字段顺序.
2.Int userId
企业ID,每个企业都有一个唯一Id.在网站展示专区后台登陆后”欢迎你”文字后面有显示.
batchInsertWeb2方法所需要传递的参数：
1.String[] job
String数组长度为16,分别代替了所有上传的信息.
依次是Ecel表里面的字段顺序.
2.Int userId
企业ID,每个企业都有一个唯一Id.在网站展示专区后台登陆后”欢迎你”文字后面有
显示.
理正标准数据接口说明及格式
理正标准数据接口 一、功能 通过该接口将理正标准接口数据读入到的数据库中（包括室内试验数据和静探数据），从而生成地层统计表、勘探点一览表、土工试验综合成果表、物理力学指标统计表、物理力学指标设计参数表等成果、生成与静探有关的成果图等。 二、接口格式 1、接口文件中包含的数据 接口中可输入的数据表包括钻孔表数据、土层表数据、静探表、取样表数据、湿陷性黄土数据、固结和固结试验项目数据、颗分和颗分试验项目数据、直剪和直剪试验项目数据、三轴和三轴试验项目数据。各数据表及数据表中的先后内容如下表：
2、接口文件具体格式 ;钻孔数据 #ZK#钻孔编号勘探点类型X坐标Y坐标偏移量孔口标高水面标高勘探深度探井深度钻孔直径勘探开始日期勘探结束日期 ;土层数据 #TC#岩土名称层底深度地层厚度主层编号亚层编号地质时代地质成因颜色密实度湿度可塑性浑圆度均匀性风化程度岩层倾向岩层倾角矿物成分结构构造包含物气味描述完整程度坚硬程度破碎程度节理发育节理间距 #TC#岩土名称层底深度地层厚度主层编号...... ... ;静探数据 #JT#试验点底深度静探类型锥头阻力侧壁摩阻力比贯入阻力 #JT#试验点底深度静探类型锥头阻力侧壁摩阻力比贯入阻力 ;取样数据 #QY#取样编号取样深度取样长度取样类型质量密度土粒比重含水量液限塑限最小密度最大密度水上休止角水下休止角渗透系数水平渗透系数垂直渗透系数单轴抗压强度自然抗压强度饱和抗压强度抗拉强度抗剪强度软化系数桩侧摩阻力桩端摩阻力十字板剪切强度无侧限抗压强度（原状）无侧限抗压强度（重塑）灵敏度透水率剪切波速纵波波速动弹性模量动剪切模量动泊松比回弹模量 ；湿陷性黄土数据 #SX#湿陷浸水压力湿陷系数δs 压力湿陷系数δ.2s 压力湿陷系数δ.3s 自重湿陷系数湿陷起始压力 #SX#湿陷浸水压力...... ...
系统设计文档模板
系统设计说明书（架构、概要、详细）目录结构 虽然这些文档一般来说公司都是有模板的，但我写这些文档以来基本上是每写一次就把目录结构 给改一次，应该说这是因为自己对这些文档的理解开始加深，慢慢的越来越明白这些文档的作用 和其中需要阐述的东西，觉得这三份文档主要阐述了一个系统的设计和实现过程，从系统分解为层次、层次内的模块以及相互的接口、模块分解为对象以及对象的接口、实现这些对象接口的方法。这次又整了一份，A/ ，欢迎大家指正。 XXX架构设计说明书 （架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系）一?概述 描述本文的参考依据、资料以及大概内容。 二.目的 描述本文编写的目的。 三.架构设计 阐明进行架构设计的总体原则，如对问题域的分析方法。 3.1. 架构分析 对场景以及问题域进行分析，构成系统的架构级设计，阐明对于系统的分层思想。 3.2. 设计思想 阐明进行架构设计的思想，可参考一些架构设计的模式，需结合当前系统的 实际情况而定。 3.3. 架构体系 根据架构分析和设计思想产生系统的架构图，并对架构图进行描述，说明分层的原因、层次的职责，并根据架构图绘制系统的物理部署图，描述系统的部署体系。3.4. 模块划分 根据架构图进行模块的划分并阐明模块划分的理由，绘制模块物理图以及模
块依赖图。 341. 模块描述 根据模块物理图描述各模块的职责，并声明其对其他模块的接口要求。。 3.4.2. 模块接口设计 对模块接口进行设计，并提供一定的伪代码。 XXX概要设计说明书 （概要设计重点在于将模块分解为对象并阐明对象之间的关系） 一.概述 描述本文的参考依据、资料以及大概内容。 二.目的 描述本文的编写目的。 三.模块概要设计 引用架构设计说明书中的模块图，并阐述对于模块进行设计的大致思路。 3.1. 设计思想 阐明概要设计的思想，概要设计的思想通常是涉及设计模式的。 3.2. 模块A 3.2.1. 概要设计 根据该模块的职责对模块进行概要设计（分解模块为对象、描述对象的职责以及声明对象之间的接口），绘制模块的对象图、对象间的依赖图以及模块主要功能的序列图，分别加以描述并相应的描述模块异常的处理方法。 3.2.2. 模块接口实现 阐明对于架构设计中定义的模块接口的实现的设计。 XXX详细设计说明书 （详细设计重点在于对模块进行实现，将模块的对象分解为属性和方法，并阐述 如何实现）
API接口调用说明及示例(第四次修订)
产品/项目名称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.试剂管理平台接口概述 试剂管理平台（以下简称“平台”）集试剂采购、审批、库房管理、废弃物处置、结算、资料查询、安全教育宣传于一体的、量身定制的信息化管理平台。“平台”以“方便师生，寓管理于服务，以服务促管理”作为指导思想，通过简化、优化采购、审批等各环节流程，透明、规范采购，实现试剂全程可追溯、全过程闭环管理。 为保证“平台”供货商产品数据更新的及时性，现将其中部分功能数据对接接口的方式向供货商提供，具体接口如下表所示： ，并获取一个秘钥（userKey）。接口成功部署后，可通过访问 http://ip:port/services/frontWebService?wsdl获取接口的详细描述。 2.数据对接方法 2.1.String sayHi(String name) 这是一个测试方法，返回"hello, " + name的字符串,测试地址为： http://ip:port/services/frontWebService/sayHello?name=J 2.2.String submit(String xmlData, String sign) 主要的业务处理方法，后面所说的xml报文，即该方法的xmlData参数，sign 为xmlData+userKey的md5密文。返回值为xml格式的字符串。 3.XML报文定义规则 3.1.请求报文
接口控制文件(模版)
文件修订页
目录 1 范围 (1) 1.1系统概述 (1) 1.2文档概述.................................................................................................错误!未定义书签。 1.3术语与缩略语 (1) 2 引用文档 (1) 3 接口设计 (1) 3.1外部接口 (1) 3.2用户接口 (2) 3.3内部接口 (2)
1 范围 1.1 系统概述 描述软件系统的运行环境、主要用途，描述软件系统的总体功能、构成、子系统构成。使得读者对系统有一个总体的概要的了解。 [读者看完系统概述知道了这个软件是做什么用的、主要的功能是什么，用在什么样的场合。这样读者就可以对系统有一个整体的了解]。 1.2 术语与缩略语 本文档使用的术语与缩略语： XXXX ：XXXXXXXXXXXX； ……； 2 引用文档 [1]《XXXXXXX》，XXXXXXXXXX，YYYY年MM月。 [2]《XXXXXXX》，XXXXXXXXXX，YYYY年MM月。 ……。 3 接口设计 3.1外部接口 说明该系统同外界的所有接口安排，包软件接口与硬件接口。 <说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。> 例如：通讯接口、直接硬件接口、支撑软件接口以及与其它软件模块间的接口设计。 1）外部网络通讯接口设计 外部通讯网络接口设计是指与本系统范围外的网络接口，如上层管理网等的接口和协议、信息流向、信息、长度和通讯周期等。 2）外部串行口通讯接口设计 外部串行口通讯接口设计是指与本系统范围外的其它系统采用串行口通讯时的接口关系，包括通讯协议(握手方式、波特率、校验方式等)、信息流向、信息长度和通讯周期等。还应说明当通讯过于频繁或超时时的措施。
帝国CMS版接口说明
帝国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目录下使用，为保密，请自行修改文件名；
软件详细设计文档模板(最全面)
研发生产中心文档编号版本A1 密级商密A 项目名称Xx系统 项目来源 Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期：检查：日期：审核：日期：批准：日期： XX公司 版权所有不得复制 文档变更记录
序号变更（+/-）说明作者版本号日期批准1 2
目录 1. 引言 (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5) 1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (7) 2.1 常量 (7) 2.2 变量 (8) 2.3 数据结构 (8) 3. 模块设计 (9) 3.1 用例图 (9) 3.2 功能设计说明 (10) 3.2.1 模块1 (10) 3.2.2 模块2 (11) 4. 接口设计 (12) 4.1 内部接口 (12) 4.2 外部接口 (12) 4.2.1 接口说明 (12) 4.2.2 调用方式 (12) 5. 数据库设计 (12) 6. 系统安全保密设计 (12) 6.1 说明 (12) 6.2 设计 (12) 6.2.1 数据传输部分 (12) 6.2.2 IP过滤分部 (13) 6.2.3 身份验证部分 (13) 7. 系统性能设计 (13) 8. 系统出错处理 (13)
1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号术语或缩略语说明性定义 1 PM Project Manager,项目经理 2 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； c．引用文件、资料、软件开发标准等。 资料名称作者文件编号、版本资料存放地点 1.5使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio]
网约车平台数据库接入情况表说明表2 .doc
网约车平台数据库接入情况表说明表（2） 测试接口数据问题明细说明： 1上报记录数量不足，要求车辆、驾驶员报送记录数量超过200，实际完成订单数量500以上，驾驶员和车辆定位信息6000以上。并且车辆保险信息、车辆里程统计信息、驾驶员培训信息、驾驶员信誉等记录数量应与车辆、驾驶员数量相符。 2. 接口中非必选字段，也就是数据表中必选选项为“否”，目前统一要求尽可能填全，规范有些细节还不是很完善，数据表中必选选项为“否”也需要上报。 A.4.1 BusinessScope 经营范围按照网络预约出租汽车经营许可证内容填写 注册资本的格式小写加汉字，单位万元，例如“3000万元”。 A.4.3 State 状态 0：有效1：失效 A.4.6 合乘车的运价比网约车的运价低。 时间的填报需严格按照总体技术要求的格式填报 OtherPeakTimeOn 其他营运高峰时间起需填报 OtherPeakTimeOff 其他营运高峰时间止需填报 FareType运价类型编码，尽可能用英文或数字 faretypenote运价类型要填写中文说明，例如“XXX运价”。 运价生效失效日期要填报符合正常业务逻辑 A.4.7 无数据 A.4.10 无数据 A.4.11 数据量不足200，目前只有198条 A.4.12 数据量不足200，目前只有198条 AppVersion 使用APP版本号应填报 A.4.13 数据量不足200，目前只有198条 A.4.14 重新推送 PassengerGender 乘客性别 1:男 2:女 FTP 文件不符合规范。 A.5.1 FareType 运价类型编码运价填报应与订单类型对应，非合乘订单应 填报非合乘的运价编码 A.6.3 FareType 运价类型编码运价填报应与订单类型对应，非合乘订单应 填报非合乘的运价编码 A.6.5 FareType 运价类型编码运价填报应与订单类型对应，非合乘订单应 填报非合乘的运价编码 A7.1 A7.2 接口，可以查询到驾驶员车辆定位信息 注意车辆和驾驶员定位信息报送要求 1 定位辅助信息，包括速度、方向等也应尽量采集报送。 2 BizStatus营运状态，技术要求中要求填报 1：载客，2：接单，3：空驶，4：停运,其中1、2状态,有订单号码,3、4状态,订单号码 0 ，不同营运状态的记录都应有报送
(完整word)软件项目文档全套模板-需求说明,推荐文档
＜项目名称＞ 软件需求说明书 作者： 完成日期： 签收人： 签收日期： 修改情况记录：
目录 1 引言 (1) 1.1 编写目的 (1) 1.2 范围 (1) 1.3 定义 (1) 1.4 参考资料 (1) 2 项目概述 (2) 2.1 产品描述 (2) 2.2 产品功能 (2) 2.3 用户特点 (2) 2.4 一般约束 (2) 2.5 假设和依据 (3) 3 具体需求 (3) 3.1 功能需求 (3) 3.1.1 功能需求1 (3) 3.1.2 功能需求2 (4) 3.1.n 功能需求n (5) 3.2 外部接口需求 (5) 3.2.1 用户接口 (5) 3.2.2 硬件接口 (5) 3.2.3 软件接口 (5) 3.2.4 通信接口 (6) 3.3 性能需求 (6) 3.4 设计约束 (6) 3.4.1 其他标准的约束 (6) 3.4.2 硬件的限制 (7) 3.5 属性 (7) 3.5.1 可用性 (7) 3.5.2 安全性 (7) 3.5.3 可维护性 (7) 3.5.4 可转移＼转换性 (8) 3.5.5 警告 (8) 3.6 其他需求 (8) 3.6.1 数据库 (8) 3.6.2 操作 (8) 3.6.3 场合适应性需求 (9) 4 附录 (9)
1 引言 1.1 编写目的 说明编写这份软件需求说明书的目的，指出预期的读者范围。 1.2 范围 说明： a．待开发的软件系统的名称； b．说明软件将干什么，如果需要的话，还要说明软件产品不干什么； c．描述所说明的软件的应用。应当： 1）尽可能精确地描述所有相关的利益、目的、以及最终目标。 2）如果有一个较高层次的说明存在，则应该使其和高层次说明中的类似的陈述相一致（例如，系统的需求规格说明）。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
概要设计说明书范例及模板
《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.1.1对接方式 系统与外部系统的对接方式以web service方式进行。 系统接口标准： 本系统采用SOA体系架构，通过服务总线技术实现数据交换以及实现各业务子系统间、外部业务系统之间的信息共享和集成，因此SOA体系标准就是我们采用的接口核心标准。主要包括： 服务目录标准：服务目录API接口格式参考国家以及关于服务目录的元数据指导规范，对于W3C UDDI v2 API结构规范，采取UDDI v2的API的模型，定义UDDI的查询和发布服务接口，定制基于Java和SOAP的访问接口。除了基于SOAP1.2的Web Service 接口方式，对于基于消息的接口采用JMS或者MQ的方式。 交换标准：基于服务的交换，采用HTTP/HTTPS作为传输协议，而其消息体存放基于SOAP1.2协议的SOAP消息格式。SOAP的消息体包括服务数据以及服务操作，服务数据和服务操作采用WSDL进行描述。 Web服务标准：用WSDL描述业务服务，将WSDL发布到UDDI用以设计/创建服务，SOAP/HTTP服务遵循WS-I Basic Profile 1.0，利用J2EE Session EJBs实现新的业务服务，根据需求提供SOAP/HTTP or JMS and RMI/IIOP接口。 业务流程标准：使用没有扩展的标准的BPEL4WS，对于业务流程以SOAP服务形式进行访问，业务流程之间的调用通过SOAP。 数据交换安全：与外部系统对接需考虑外部访问的安全性，通过IP白名单、SSL 认证等方式保证集成互访的合法性与安全性。 数据交换标准：制定适合双方系统统一的数据交换数据标准，支持对增量的数据自动进行数据同步，避免人工重复录入的工作。 1.1.2接口规范性设计 系统平台中的接口众多，依赖关系复杂，通过接口交换的数据与接口调用必须遵循统一的接口模型进行设计。接口模型除了遵循工程统一的数据标准和接口规范标准，实现接
接口文档规范
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 3.7.3 对接方式 系统与外部系统的对接方式以web service方式进行。 系统接口标准： 本系统采用SOA体系架构，通过服务总线技术实现数据交换以及实现各业务子系统间、 外部业务系统之间的信息共享和集成，因此SOA体系标准就是我们采用的接口核心标准。主要包括： 服务目录标准：服务目录API接口格式参考国家以及关于服务目录的元数据指导规范， 对于W3C UDDI v2 API结构规范，采取UDDI v2 的API的模型，定义UDDI的查询和发布服务接口，定制基于Java和SOAP的访问接口。除了基于SOAP1.2的Web Service接口方式，对于基于消息的接口采用JMS或者MQ的方式。 交换标准：基于服务的交换，采用HTTP/HTTPS作为传输协议，而其消息体存放基于 SOAP1.2协议的SOAP消息格式。SOAP的消息体包括服务数据以及服务操作，服务数据和服务操作采用WSDL进行描述。 Web服务标准：用WSDL描述业务服务，将WSDL发布到UDDI用以设计/创建服务，SOAP/HTTP服务遵循WS-I Basic Profile 1.0，利用J2EE Session EJBs 实现新的业务服务，根据需求提供SOAP/HTTP or JMS and RMI/IIOP接口。 业务流程标准：使用没有扩展的标准的BPEL4WS，对于业务流程以SOAP服务形式进行访问，业务流程之间的调用通过SOAP。 数据交换安全：与外部系统对接需考虑外部访问的安全性，通过IP白名单、SSL认证等方式保证集成互访的合法性与安全性。 数据交换标准：制定适合双方系统统一的数据交换数据标准，支持对增量的数据自动进行数据同步，避免人工重复录入的工作。 1.1.2 3.3.8接口规范性设计 系统平台中的接口众多，依赖关系复杂，通过接口交换的数据与接口调用必须遵循统一的接口模型进行设计。接口模型除了遵循工程统一的数据标准和接口
软件开发文档模板库
软件开发文档模板库 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 关键问题
软件详细设计文档模板
项目编号： （项目名称） 软件详细设计报告文件编号：生效日期：年月日 编制：日期：审核： 日期： 批准： 日期：同方锐安科技有限公司
目录 1. 引言 (1) 1.1编写目的 (1) 1.2项目风险 (1) 1.3文档约定 (1) 1.4预期读者和阅读建议 (1) 1.5参考资料 (2) 2. 支撑环境 (2) 2.1数据库管理系统 (2) 2.2开发工具、中间件以及数据库接口 (2) 2.3硬件环境 (2) 2.4网络环境 (3) 2.5多种支撑环境开发要点 (3) 3. 部件详细设计 (4) 4. 词汇表 (5) 5. 部件表格式 (5) 6. 界面表格式 (6)
1. 引言 引言是对这份软件系统详细设计报告的概览，是为了帮助阅读者了解这份文档如何编写的，并且应该如何阅读、理解和解释这份文档。 1.1 编写目的 说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书(如果该软件产品需要数据库支持)编写的，开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构，从而对该软件产品的物理组成进行准确的描述。 1.2 项目风险 具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括： ●任务提出者； ●软件开发者； ●产品使用者。 1.3 文档约定 描述编写文档时所采用的标准(如果有标准的话)，或者各种编写约定。 编写约定包括： ●部件编号方式； ●界面编号方式； ●命名规范： ● 1.4 预期读者和阅读建议 列举本软件系统详细设计报告所针对的各种不同的预期读者，描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。 读者包括： ●开发人员； ●项目经理； ●测试人员； ●文档编写人员； ●
项目接口文档
接口使用说明书 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. 上传多媒体资源................................................................. 错误！未定义书签。