[发明专利]通用的API接口配置及编排方法、系统、介质及设备

说明书

本发明提供了一种通用的API接口配置及编排方法、系统、介质及设备，包括：步骤S1：在系统前端页面配置API的输入输出参数；步骤S2：在系统前端页面配置API的核心业务逻辑，使用模版语言实现；步骤S3：配置API的授权信息；步骤S4：业务系统通过授权信息访问已配置好的API。本发明通过在web页面上将API需要的输入输出参数进行统一的配置，并据此实现API的接口，可以提升API开发效率；本发明可以统一管理API的认证、授权、限流、熔断等通用功能，从而实现API功能复用，提升企业软件开发效率；本发明通过模版语言实现API的数据获取逻辑，可以实现任意业务逻辑的API配置与编排。

技术领域

本发明涉及信息技术领域，具体地，涉及一种通用的API接口配置及编排方法、系统、介质及设备。

背景技术

传统的API是通过编码的方式实现，但在业务需求快速变化的今天，对每个具体的数据获取都要写代码实现成本是比较高的。

现有的API大多数是通过代码写好相应的业务逻辑，再暴露给别的系统调用，程序运行起来后就不可以修改，是静态的；此外，现有的API配置平台多数是通过配置SQL过滤选项自动获取数据，无法实现复杂的业务逻辑，例如对参数进行拼装组合等、组合多条SQL数据生成响应报文等。

专利文献CN108965007B(申请号：CN201810796256.6)公开了一种API网关接口配置更新方法及装置，包括：将API接口的配置信息写入分布式配置中心；API网关在启动时，从所述分布式配置中心获取所述API网关包括的各API接口的配置信息；在所述分布式配置中心中所写入的API接口的配置信息更新时，相应的API接口从所述分布式配置中心获取更新后的配置信息。但该发明API不是动态配置生成的。

发明内容

针对现有技术中的缺陷，本发明的目的是提供一种通用的API接口配置及编排方法、系统、介质及设备。

根据本发明提供的一种通用的API接口配置及编排方法，包括：

步骤S1：在系统前端页面配置API的输入输出参数；

步骤S2：在系统前端页面配置API的核心业务逻辑，使用模版语言实现；

步骤S3：配置API的授权信息；

步骤S4：业务系统通过授权信息访问已配置好的API。

优选地，在所述步骤S1中：

步骤S1.1：配置输入参数名称；

步骤S1.2：配置输入参数的校验逻辑，包括长度限制和范围限制；

步骤S1.3：配置输出参数名称；

步骤S1.4：配置输出包括参数长度限制和压缩方式。

优选地，在所述步骤S2中：

步骤S2.1：配置数据获取逻辑，包括：

SQL类数据：配置SQL，并引用输入参数，使用模版语言实现动态SQL；

HBase类数据：配置行列扫描过滤逻辑，通过模版语言实现；

ElasticSearch类数据：配置查询json的数据，引用输入参数；

API接口类数数据：配置调用其他API接口数据；

Redis类数据：配置获取Redis类数据；

步骤S2.2：配置输出参数与所获取数据的业务逻辑关系，以及输出数据的格式。

优选地，在所述步骤S3中：

步骤S3.1：配置API访问的授权信息，包括调用者ID、调用者秘钥和允许访问的IP；