介绍

接口平台是描述和定义系统自身API，以及外部周边系统API的平台；

他的作用是

• 定义内部工作流、或表达式引擎可访问的内部方法；
• 定义本系统，有哪些API，及接口参数格式；
• 外部系统有哪些API，及他们的接口地址、协议、参数格式；
• 定义外部有哪些系统，及各系统的环境；
• 辅助生成接口序列化实体；
• 测试接口；
• 查看接口调用记录；
• 监控接口性能和访问情况；
• 辅助生成接口文档；
• 接口模拟，方便调试程序；

接口关键字段

字段	说明	示例
uuid	32位唯一ID	50e5df9b-76bd-48ba-bd1d-4ddff78c32f4
name	接口编码	必须符合Java标识符特性，且系统内唯一, 比如: WCS-TPLK-CALLBACK/RULE-PUTAWAY
title	接口中文名描述	比如: 托盘立库回调/上架规则
desc	接口描述	生成接口文档时使用的数据
url	接口地址	如: /wms/integration/wcs/commService, 当 type='Method/Rule/Bpmn' 情况下此字段可能为空
request	参数声明	02_bean_schema
response	返回值声明	02_bean_schema
impletement	实现类	com.galaxis.wms.Test
inject	实现类注入参数	当 type=Method, 并且URL有值，允许对外访问的情况下，字段用来额外添加参数，比如
type	接口类型	Extenal = 外部系统 / Internal = 内部系统 / Method = 内部方法 / Rule = 规则引擎 / Bpmn = 工作流方法
group	接口类别	规则/工作流/系统方法/业务方法/RCS/WCS/ERP ...
category	小类	小类, 比如: group=WMS 时, 还可以分为 入库, 出库, 移库, 盘点, 调度等等
options	其他附加选项
mock	接口仿真
assert	断言

外部系统关键字段

字段	说明	示例
uuid	32位唯一ID	50e5df9b-76bd-48ba-bd1d-4ddff78c32f4
name	系统编码	必须符合Java标识符特性，且系统内唯一, 比如: WCS/MFC/ERP
title	系统名称	比如: 设备控制系统/多层穿梭车调度系统/ERP系统
desc	系统描述	生成接口文档时使用的数据
envs	环境变量	如: [{name:'测试环境', variables: { server: 'http://192.168.1.1' } }, { name: '生产环境' }]

关键功能

• 重新反射刷新接口描述
• 外部系统定义
• 外部系统接口定义
• 单个API功能:
• 编辑
• 测试
• 代码生成
• 模拟
• 日志
• 监控
• 环境控制