Q/GUOSEN
国信证券股份有限公司企业标准
Q/GUOSEN-ENG-INE 01-2023
国信证券股份有限公司 发布
前言
本标准于2023年7月初次起草发布，8月首次实施，在编制过程中得到各位同仁的大力支持，在此表示感谢！由于编制时间紧促，难免有遗漏之处，恳请广大参阅者多提高贵意见，以供参考校正.
本标准由国信证券股份有限公司提出.
本标准起草单位：国信证券股份有限公司.
本标准于2023年8月首次发布.
1范围
本标准规定了数据标准对外服务接口和应用规范，包括接口方式，服务设计原则，服务报文规范等，含数据服务接口6个：标准关联元数据模型视图，标准详情信息视图，标准详情弹框访问URL，标准详情接口，表字段模型接口，元数据映射标准查询接口.
本标准适用于各数据应用和管理系统的开发人员、使用人员.
2规范性引用文件
下列文件对于本文件的应用是必不可少的.凡是注日期的引用文件，仅所注日期的版本适用于本文件.凡是不注日期的引引用文件，其最新版本（包括的修改单）适用于本文件.
GB/T1.1-2020《标准化工作导则第一部分：标准化文件的结构和起草规则》
3术语和缩略语
表1术语说明
术语、缩略语 解释直译表示“表述性状态转移”，是一种跨平台、跨语言的架构风格，而不是一种标准.REST 为软件设计提供了一组原则和约束条件，但这是原则和约束的条件均不具有标准性.RESTful 即满足REST约束条件和原则的应用程序或设计.JSR Java规范提案JAX-RS JAX-RS标准是在Java领域对REST式的Web服务制定的实现标准.JSR311的规范提 案，对应JAX-RS1.0，1.1规范：JSR339的规范提案，对应JAX-RS2.0规范.JAX-WS JAX-WS标准是在Java领域对"大Web服务"制定的实现标准.JSR224的规范提案，对应JAX-WS2.0，2.1，2.2规范是JAX-RS（JSR311，JSR339）标准的参考实现，也是JavaEE参考实现项目GlassFish的Jersey 成员项目.Big Web Services 对基于SOAPWSDLUDDIWS标准栈等技术实现RPC风格的大型Web服务的统称.NOSr 一种轻量级的数据交换格式计算处理时的新建（Create）、读取查询（Retrieve）、更新（Update）和删除CRUD （Delete）几个单词的首字母简写AS 认证服务器
BS 业务认证模块innerKeyld Http头中自定义项x-Inner-Keyld 对应的值，指的是DES密钥对应的唯一编码，由认证服务生成
4接口方式
WEB服务采用REST风格，服务提供方式满足JAX-RS2.0规范（JSR339）.
客户端与后端服务之间的数据传递使用HTTP或者HTTPS作为应用协议（不是传输协议，旧接口可以采用传输协议方式过渡）.
5服务设计原则
由于对内对外的各个系统与平台之间存在差异性，为了保证服务的稳定高效、标准化.服务采用基于RESTfuIAPI的服务设计.
5.1接口协议统一原则
服务的接口均基于HTTP或HTTPS协议.调用的服务通过HTTPURL中特定属性进行标识，参见“服务原语报文规范”章节.与SOAP或其他标准不同，REST要求用来操纵资源的方法或动词不是任意的.这意味着RESTfuI服务的开发人员只能使用HTTP支持的方法，比如GET、PUT、POST、DELETE等等.因此不需要使用WSDL等服务描述语言.
5.2数据格式统一原则
①报文统一采用UTF-8进行编码.
②请求与响应的公共信息（请求时间，请求源等）存储在Http协议头部信息中.除了协议已经规定Authorization、Date字段直接可用之外，其他自定义公共信息也存在的header头元素.
③请求报文（新增数据场景）与响应报文中的业务数据，数据采用JSON格式表示，并且符合相应的JSONSchema.服务提供方和服务消费方必须同时使用同一种格式进行数据交互.JSON不同含义的段落应定义明确含义的字段名称，相同内容的数据应采用数组来进行描述，双方可根据JSON名称和路径进行精确定位，不应根据字段的顺序来获取字段值，字段值不受字段顺序调整的影响.具体业务数据的格式，不在本规范中描述，但定义方式可参照规范的“示例”章节.
6服务报文规范
为保证数据封装服务中交换的消息具有一致性的理解，必须对服务的接口消息结构进行统一的规范和定义.接口消息结构的统一将在数据接口层面上形成统一标准，实现在各模块之间与外部系统的数据交互的标准化和规范化.
REST架构风格的WEB服务，要求Http协议做为应用协议，而非仅仅是传输协议使用.因此报文的定义http协议进行扩展.
消息请求结构
REST请求就是HTTP或HTTPS的请求，请求消息结构也就是http请求的消息结构.消息请求结构包括消息请求行、消息请求头和消息请求正文.
请求行：描述请求动作.
请求头：描述http协议本身以及自定义的公共信息.
请求正文：描术请求的业务信息.
请求信息以各种“参数”的形式存在，分布在消息结构中，包括有请求路径参数，自定义头参数，查询字符串参数，请求体参数
7数据服务接口
7.1标准关联元数据模型视图
视图描述 标准关联元数据模型视图数据库类型 Mysql视图名 v_table_std_to_external库名 XXXIP:端口 IP:PORT用户/密码 xxx/xxx
视图字段说明：
视图字段名称 类型 数据长度 中文描述schemaName String 32 Schema名（大写）
