保险对接开放平台

背景

保险开放平台一期的主要功能是为商业保险公司的对接提供更加便捷联调环境和联调方式，增加对接效率。所以一期的主要功能即提供一个标准的，自动化的联调平台。联调平台会有需要对接的各系统模块的标准接口，联调完毕即可上线。从而降低以前反复沟通确认接口的成本。

数据模型

基本数据类型

自定义类型

自定义类型通常有一系列基本数据类型和一系列的自定义类型组成。

接口定义

这里的接口跟java的interface不是一个含义。这里的接口指的是系统之间通过约定而形成的对接标准。通常包含几下几项

• 请求类型
  请求类型在本平台默认为http/https请求。
• 请求方式
  请求方式针对请求类型而定义，在http请求类型下，请求方式为请求GET/POST两种类型。
• 请求入参
  请求入参有固定入参和自定义入参两种类型。其中固定入参是必选项。自定义入参根据接口功能而定义。

{
    "version":"1.0",
    "sign":"HDSFD343T45ADFE",
    "requestType":"queryRecord",
    "input":"HISAAFDDFEFDSFASFEFASFDSFGGHG"
 }

其中"version","sign","requestType"为固定入参，"input"为自动以入参，input的计算方式详见文档。
- 请求返回
请求返回也固定的返回参数，和自定义的返回参数两类。如果实例所示：

{
    "version":"1.0",
    "retCode":"0",
    "sign":"HDSFD343T45ADFE",
    "messsage":"fasd",
    "output":"FDSAFEGAGADGAFADFWEWERGAGGEGW"
}

其中"version","retCode","sign","message"为固定的返回参数，output为自定义的参数，会根据接口的不同而不同。

数据库模型

数据类型(基本/自定义)

CREATE TABLE `data_type`(
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `code` varchar(20) NOT NULL DEFAULT '' COMMENT '类型,比如String',
    `data_type_name` varchar(20) NOT NULL DEFAULT '' COMMENT '对类型的描述',
    `define_type` varchar(20) NOT NULL DEFAULT '' COMMENT '定义类型:BASIC/CUSTOM',
    `remark` text COMMENT '该类型的备注',
    `create_time` timestamp NOT NULL DEFAULT '1971-01-01 00:00:00' COMMENT '创建时间',
    `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    PRIMARY KEY (`id`),
    UNIQUE KEY `uniq_code_type` (`code`, `define_type`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='基本数据类型';

CREATE TABLE `custom_datatype_field`(
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `code` varchar(20) NOT NULL DEFAULT '' COMMENT '类型,比如String',
    `field_name` varchar(20) NOT NULL DEFAULT '' COMMENT '对类型的描述',
    `data_type_id` int(11) NOT NULL DEFAULT 0 COMMENT '所属数据类型id',
    `field_data_type_id` int(11) NOT NULL DEFAULT 0 COMMENT '本字段数据类型id',
    `collectable` tinyint(1) DEFAULT 0 COMMENT '是否是集合类型',
    `collection_type` varchar(20) NOT NULL DEFAULT 'LIST' COMMENT '集合类型',
    `remark` text COMMENT '该类型的备注',
    `create_time` timestamp NOT NULL DEFAULT '1971-01-01 00:00:00' COMMENT '创建时间',
    `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    PRIMARY KEY (`id`),
    UNIQUE KEY `uniq_data_type_id_code` (`data_type_id`, `code`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='字段';

custom_datatype_field

接口类型

CREATE TABLE `open_interface`(
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `interface_name` varchar(20) NOT NULL DEFAULT '' COMMENT '接口名字',
    `interface_request_type` varchar(20) NOT NULL DEFAULT 'HTTP' COMMENT '接口请求类型',
    `request_method` varchar(20) NOT NULL DEFAULT 'GET' COMMENT '请求方式',
    `provider_type` varchar(50) NOT NULL DEFAULT 'PLATFORM' COMMENT '接口提供方',
    `url` varchar(100) NOT NULL DEFAULT '' COMMENT '资源url',
    `version` varchar(20) NOT NULL DEFAULT '1.0.0' COMMENT '接口版本号',
    `remark` text DEFAULT '' COMMENT '备注',
    `create_time` timestamp NOT NULL DEFAULT '1971-01-01 00:00:00' COMMENT '创建时间',
    `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    PRIMARY KEY (`id`),
    KEY `idx_provider_type` (`provider_type`),
    KEY `idx_version` (`version`),
    UNIQUE KEY `uniq_name_version` (`interface_name`, `version`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='对外接口';

interface

CREATE TABLE `interface_fixed_param`(
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `param_name` varchar(50) NOT NULL DEFAULT '' COMMENT '参数名字',
    `code` varchar(20) NOT NULL DEFAULT '' COMMENT '参数code',
    `param_group` varchar(20) NOT NULL DEFAULT 'FIXED_INPUT' COMMENT '参数组别',
    `param_type_id` int(11) NOT NULL DEFAULT 0 COMMENT '参数数据类型',
    `must_required` tinyint NOT NULL DEFAULT 0 COMMENT '是否必填',
    `example_value` text DEFAULT '' COMMENT '示例值',
    `default_value` text DEFAULT '' COMMENT '默认值',
    `version` varchar(20) NOT NULL DEFAULT '1.0.0' COMMENT '固定参数版本号',
    `remark` text DEFAULT '' COMMENT '备注',
    `create_time` timestamp NOT NULL DEFAULT '1971-01-01 00:00:00' COMMENT '创建时间',
    `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    PRIMARY KEY (`id`),
    KEY `idx_version` (`version`),
    UNIQUE KEY `uniq_group_code_version` (`param_group`, `code`, `version`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='接口固定参数';

interface_fixed_param

interface_custom_param

CREATE TABLE `interface_custom_param`(
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `param_name` varchar(50) NOT NULL DEFAULT '' COMMENT '参数名字',
    `code` varchar(20) NOT NULL DEFAULT '' COMMENT '参数code',
    `param_group` varchar(20) NOT NULL DEFAULT 'CUSTOM_INPUT' COMMENT '自定义参数组别',
    `interface_id` int(11) NOT NULL DEFAULT 0 COMMENT '所属接口id',
    `param_type_id` int(11) NOT NULL DEFAULT 0 COMMENT '参数数据类型',
    `must_required` tinyint NOT NULL DEFAULT 0 COMMENT '是否必填',
    `example_value` text DEFAULT '' COMMENT '示例值',
    `default_value` text DEFAULT '' COMMENT '默认值',
    `remark` text DEFAULT '' COMMENT '备注',
    `create_time` timestamp NOT NULL DEFAULT '1971-01-01 00:00:00' COMMENT '创建时间',
    `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    PRIMARY KEY (`id`),
    KEY `idx_interface_id` (`interface_id`),
    KEY `idx_param_group` (`param_group`),
    UNIQUE KEY `uniq_interface_id_code` (`interface_id`, `code`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='接口自定义参数';

interface_example

CREATE TABLE `interface_example`(
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `example_name` varchar(50) NOT NULL DEFAULT '' COMMENT 'example名称',
    `interface_id` int(11) NOT NULL DEFAULT 0 COMMENT '接口id',
    `example_type` varchar(20) NOT NULL DEFAULT 'INPUT' COMMENT 'example类型',
    `example_value` text DEFAULT '' COMMENT '示例值，通常为json串或者压缩后的json串',
    `remark` text DEFAULT '' COMMENT '备注',
    `create_time` timestamp NOT NULL DEFAULT '1971-01-01 00:00:00' COMMENT '创建时间',
    `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    PRIMARY KEY (`id`),
    UNIQUE KEY `idx_interface_id_example_type` (`interface_id`, `example_type`),
    KEY `idx_example_type` (`example_type`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='接口参数示例';

partner

CREATE TABLE `partner`(
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `partner_name` varchar(50) NOT NULL DEFAULT '' COMMENT '合作公司名称',
    `contact_phone` varchar(20) NOT NULL DEFAULT '' COMMENT '联系人电话',
    `username` varchar(50) NOT NULL DEFAULT 0 COMMENT '用户名',
    `password` varchar(50) NOT NULL DEFAULT 'INPUT' COMMENT '用户密码',
    `base_host` text DEFAULT '' COMMENT '请求basehost',
    `hmac` varchar(50) NOT NULL DEFAULT '' COMMENT '私钥',
    `status` varchar(20) NOT NULL DEFAULT '' COMMENT '状态',
    `remark` text DEFAULT '' COMMENT '备注',
    `create_time` timestamp NOT NULL DEFAULT '1971-01-01 00:00:00' COMMENT '创建时间',
    `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    PRIMARY KEY (`id`)
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='合作公司 ';

导航数据

CREATE TABLE `navi_view`(
    `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `parent_id` int(11) unsigned NOT NULL DEFAULT 0 COMMENT '父级导航id',
    `view_order` int(4) unsigned NOT NULL DEFAULT 0 COMMENT '排序',
    `label` varchar(50) NOT NULL DEFAULT '' COMMENT '导航名称',
    `route` varchar(50) NOT NULL DEFAULT '' COMMENT '导航url',
    `showable` tinyint(1) DEFAULT 0 COMMENT '是否展示',
    `icon` varchar(20) NOT NULL DEFAULT '' COMMENT 'icon',
    `platform` varchar(20) NOT NULL DEFAULT '' COMMENT '平台类型:ADMIN/PLATFORM',
    `create_time` timestamp NOT NULL DEFAULT '1971-01-01 00:00:00' COMMENT '创建时间',
    `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    PRIMARY KEY (`id`),
    KEY 'idx_platform' (`platform`),
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='导航元素';

前端交互

后台部分

数据类型

基本操作

增加基本类型

url: /open/admin/dataType/add
method:post
输入参数

输入示例

{
    "name":"字符串",
    "code":"String",
    "type":"BASIC",
    "remark":"格式必须为****"
}

返回示例

{
    "resCode":0,
    "msg":null,
    "data":null
}

删除基本类型

url:/open/admin/dataType/del
method:get
输入参数

返回示例

{
    "resCode":0,
    "msg":null,
    "data":null
}

编辑基本类型

url:/open/admin/dataType/edit
method:post
输入参数

{
    "id":"123",
    "name":"字符串",
    "code":"String",
    "type":"BASIC",
    "remark":"格式必须为****",
}

返回示例

{
    "resCode":0,
    "msg":null,
    "data":null
}

查询基本类型

url:/open/admin/dataType/list
method:get
返回示例

{
    "resCode":0,
    "msg":"null",
    "basic":[
        {
            "id":"123",
            "name":"字符串",
            "code":"String",
            "type":"BASIC",
            "remark":"格式必须为****", 
        },
        {
            "id":"123",
            "name":"字符串",
            "code":"String",
            "type":"BASIC",
            "remark":"格式必须为****",        
        }
    ],
    "custom":[
        {
            "id":"123",
            "name":"自定义1",
            "code":"Car",
            "type":"CUSTOM",
            "remark":"小汽车",
        },
        {
            "id":"123",
            "name":"自定义1",
            "code":"Cat",
            "type":"CUSTOM",
            "remark":"小猫",
        }
    ]
}

原型设计

自定义类型中的字段

基本操作

增加一个字段

url:/open/admin/field/add
method:post
输入参数

输入示例：

 {
    "name":"字符串",
    "code":"String",
    "dataTypeId":"1",
    "fieldDataTypeId":"1",
    "collectable":"true",
    "collectionType":"LIST",
    "remark":"fasdfasdf"
 }

返回示例

{
    "resCode":0,
    "msg":null,
    "data":null
}

删除一个字段

url:/open/admin/field/del
method:get
输入参数：

返回示例

{
    "resCode":0,
    "msg":null,
    "data":null
}

编辑一个字段

url:/open/admin/field/edit
method:post
输入参数

{
    "id":11
    "name":"字符串",
    "code":"String",
    "dataTypeId":"1",
    "fieldDataTypeId":"1",
    "collectable":"true",
    "collectionType":"LIST",
    "remark":"fasdfasdf"
}

返回示例

{
    "resCode":0,
    "msg":null,
    "data":null
}

固定参数

基本操作

增加一个固定参数

url: /open/admin/fixedParam/add
method:post
输入参数：

{
    "name":"验签值",
    "code":"sign",
    "paramGroup":"FIXED_INPUT_PARAM",
    "paramDataTypeId":"1",
    "mustRequired":"true",
    "exampleValue":"FASDFJWE2323",
    "defaultValue":"无",
    "remark":"接口验签",
    "version":"1.0.0",
}

删除一个固定参数

url：/open/admin/fixedParam/del
method:get

返回示例

{
    "resCode":0,
    "msg":null,
    "data":null
}

编辑一个固定参数

url: /open/admin/fixedParam/update
method:post
输入参数

{
    "id":12,
    "name":"验签值",
    "code":"sign",
    "paramGroup":"FIXED_INPUT_PARAM",
    "paramDataTypeId":"1",
    "mustRequired":"true",
    "exampleValue":"FASDFJWE2323",
    "defaultValue":"无",
    "remark":"接口验签",
    "version":"1.0.0",
}

查询固定参数

url:/open/admin/fixedParam/list
method:get
输入参数：

接口

自定义参数

接口示例

商保公司基础信息

开放平台部分