CN115242481A - 使用开放平台管理微服务接口的方法及电子设备 - Google Patents

Abstract

本发明涉及计算机技术领域，具体涉及一种使用开放平台管理微服务接口的方法及电子设备，本发明包括以下步骤：S1通过业务微服务为开放平台提供接口，并在需要注册的微服务接口中增加注解；S2开发者为客户端申请应用，并自动生成应用密钥，客户端通过密钥接入开放平台；S3开发者接入开放平台接口，核验S2生成的应用密钥后读取应用设置；S4进行用户鉴权，经判断后自行调用对应的微服务接口，并在输出最终结果后，结束接口调用。本发明开发到上线，各个环节的效能都得到了提升，加快了产品交付效能，达到敏捷开发、敏捷交付的目的。

Description

使用开放平台管理微服务接口的方法及电子设备

技术领域

本发明涉及计算机技术领域，具体涉及一种使用开放平台管理微服务接口的方法及电子设备。

背景技术

在微服务环境中，负责处理具体业务逻辑的业务服务接口很多时候需要同时提供移动端、web端、小程序等多个客户端使用，由于各客户端数据处理的流程和数据格式的要求不一样，所以得为各客户端封装一个服务来处理解决这些差异，导致数据处理流程中一些重复的步骤得在各端的服务中同时实现，这样加重了开发的复杂性，且不利于维护。

图5列举了移动端和web端服务在处理接口时的流程，在实现相同的业务功能时，红色虚线框部分的功能：鉴权、输入数据转换和输出数据转换、输出等方法有着相同的处理流程，是可统一集中处理的部分。

因此，客户端对接服务接口还面临着接口版本管理、接口文档管理、SDK下载管理、沙箱环境管理、接口计费与限流、接口性能监控、访问日志查询等多种业务问题需要集中解决。

发明内容

针对现有技术的不足，本发明公开了一种使用开放平台管理微服务接口的方法及电子设备，用于解决上述问题。

本发明通过以下技术方案予以实现：

第一方面，本发明提供了一种使用开放平台管理微服务接口的方法，包括以下步骤：

S1通过业务微服务为开放平台提供接口，并在需要注册的微服务接口中增加注解；

S2开发者为客户端申请应用，并自动生成应用密钥，客户端通过密钥接入开放平台；

S3开发者接入开放平台接口，核验S2生成的应用密钥后读取应用设置；

S4进行用户鉴权，经判断后自行调用对应的微服务接口，并在输出最终结果后，结束接口调用。

更进一步的，所述方法中，自动上报接口注册到开放平台，并在开放平台中可重新定义出入参数。

更进一步的，所述方法中，在注册到开放平台的所有接口中选择订阅需要使用到的业务接口，并设置应用的数据流程。

更进一步的，所述方法中，应用的设置和接口订阅完成后，提交审核，由管理员审查客户端应用选择的数据流程、接口和相关的参数设置是否合理。

更进一步的，所述方法中，读取完应用设置后就进行用户鉴权，鉴权通过后，对获取到的应用设置中的验签标识决定是否做验签。

更进一步的，所述方法中，不需要验签或验签通过后，对获取到的应用设置中的解密标识决定是否做输入数据的解密；

不需要解密或解密数据通过后，就取到了客户端传入的参数，按用户订阅接口的设置检查是否需要转换入参。

更进一步的，所述方法中，不需要转换入参或转换入参后，得到微服务接口相应的原始入参，开始调用对应的微服务接口；

调用微服务接口后，得到调用结果，按用户订阅接口的设置检查是否需要转换出参。

更进一步的，所述方法中，不需要转换出参或转换出参后，对获取到的应用设置中的加密标识决定是否需要加密返回数据；

不需要加密或加密数据完成后，对获取到的应用设置中的签名标识决定是否需要加入签名；

不需要加入签名或加签名完成后，输出最终结果，结束接口调用。

更进一步的，所述方法中，鉴权不通过、校验不正确、验证不正确时都直接转到输出结果，结束接口调用。

第二方面，本发明提供了一种电子设备，包括处理器、存储器以及存储在所述存储器中且被配置为由所述处理器执行的计算机程序，所述存储器与所述处理器耦接，且所述处理器执行所述计算机程序时，实现第一方面所述的使用开放平台管理微服务接口方法中的步骤。

本发明的有益效果为：

本发明实现通过开放平台管理微服务接口后，开发新的业务接口时只需要实现一次业务逻辑，就能快速的支持多个客户端的开发，而且实现微服务接口时，不需要管鉴权、加解密、签名、出入参筛选等流程开放，加快了开发的速度。进入联调和测试时，由于开放平台提供了沙箱环境、访问日志查询、接口性能监控，为测试提供了便利，测试效率也大大提升。部署上线时由于只需要部署一个服务，简化了部署工作。所以从开发到上线，各个环节的效能都得到了提升，加快了产品交付效能，达到敏捷开发、敏捷交付的目的。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是使用开放平台管理微服务接口的方法的流程框图；

图2是本实施例方法实施例框图；

图3是本发明实施例开发者为客户端申请应用流程图；

图4是本发明实施例开发者接入开放平台接口时流程图；

图5是本发明背景技术移动端和web端服务在处理接口时的流程图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

实施例1

参照图1所示，本实施例提供了一种使用开放平台管理微服务接口的方法，包括以下步骤：

S1通过业务微服务为开放平台提供接口，并在需要注册的微服务接口中增加注解；

S2开发者为客户端申请应用，并自动生成应用密钥，客户端通过密钥接入开放平台；

S3开发者接入开放平台接口，核验S2生成的应用密钥后读取应用设置；

S4进行用户鉴权，经判断后自行调用对应的微服务接口，并在输出最终结果后，结束接口调用。

本实施例设计使用开放平台统一管理各客户端需要使用的微服务接口，开发者通过开设不同的应用来管理各客户端接入。

本实施例应用管理提供如下功能：应用配置数据流程的处理方案，实现统一应用鉴权与用户鉴权、数据签名与验签、数据加密与解密、输入输出数据校验与格式化。

本实施例还可以提供以下服务：接口数据采集、接口访问日志和计数、性能监控与限流、接口文档管理、沙箱等服务。解决业务接口所有可以公共处理流程，让微服务业务开发更纯粹、更简单快捷。

本实施例在开放平台中通过简单的设置，可以快速采集微服务环境中各服务需要开放的接口，实现接口在各个端中能重新定义、转义，更简单方便管理接口，并快速生成和维护接口文档。还能管理其它开发者、其它平台、企业级的用户接入，使用现有的业务接口，实现与入驻开发者应用间的业务数据对接。

实施例2

在具体实施层面，参照图2所示，设计开放平台与业务微服务在同一个微服务集群内，使用同一个注册、配置服务器。客户端与开放平台间通过HTTPS协议通讯，更安全；开放平台与业务微服务之间采用微服务RPC的方式调用，更高效、更快捷。

本实施例使用开放平台需要先完成应用管理、业务微服务接口注册、开发者接入等步骤，流程如下：

1.业务微服务为开放平台提供接口，在需要注册的微服务接口中增加注解，***自动上报接口注册到开放平台，并可以在开放平台中可重新定义出入参数。

参照图3所示，2.开发者为客户端申请应用，具体申请流程如下：

2.1.创建应用，***自动生成应用密钥，客户端可以通过密钥接入开放平台。

2.2.设置应用的数据流程，开放平台预设一些常用的加密和解密方法、签名和验签方法，让开发者自行选择使用。

2.3.为应用选择订阅需要使用到的业务接口，可以在注册到开放平台的所有接口中选择。

2.4.如有必要，可以为每一个接口重定义入参和出参，需要和开放平台中注册的微服务接口参数一一对应，可以重新命名每一个参数，也可以删减部分不需要的参数。

2.5.应用的设置和接口订阅完成后，需要提交审核，由管理员审查客户端应用选择的数据流程、接口和相关的参数设置是否合理。

2.6.审核通过后，即可开通使用，可以在开放平台中查看应用具体订阅的接口详细文档，下载相关SDK进行开发接入。

参照图4所示，3.开发者接入开放平台接口时，开放平台的接口具体执行流程如下：

3.1.开始调用接口时需要提供2.1中生成的应用密钥，以校验识别客户端应用，校验通过则读取应用设置。

3.2.读取完应用设置后就进行用户鉴权，鉴权通过后，按3.1中获取到的应用设置中的验签标识决定是否做验签。

3.3.不需要验签或验签通过后，按3.1中获取到的应用设置中的解密标识决定是否做输入数据的解密。

3.4.不需要解密或解密数据通过后，就取到了客户端传入的参数，按用户订阅接口的设置检查是否需要转换入参。

3.5.不需要转换入参或转换入参后，得到微服务接口相应的原始入参，开始调用对应的微服务接口。

3.6.调用微服务接口后，得到调用结果，按用户订阅接口的设置检查是否需要转换出参。

3.7.不需要转换出参或转换出参后，按3.1中获取到的应用设置中的加密标识决定是否需要加密返回数据。

3.8.不需要加密或加密数据完成后，按3.1中获取到的应用设置中的签名标识决定是否需要加入签名。

3.9.不需要加入签名或加签名完成后，输出最终结果，结束接口调用。

3.10.以上流程中，鉴权不通过、校验不正确、验证不正确时都直接转到输出结果，结束接口调用。

实施例3

在实施例2的基础上，本实施例继续实施，产品需要在在移动端、小程序和web端开发一个实时查询车辆位置信息的功能，由于每次查询都需要调用地图解析经纬度拿到地址信息，所以限制每分钟只能查询一次。按以前的开发方法，需要按三个客户端不同的通讯方式和流程，分别开发三个接口，且在接口内都要实现限流，估计后端总共需要3人天的开发工时，前端和移动端需要4人天，测试需要3人天，运维需要1人天，总工时11人天。

本实施例引入了开放平台管理微服务接口的方法后，由于后端只需要开发一个接口，只需要1人天的开发工时，前端和移动端工时不变还是4人天，测试只需要关注一个接口的业务逻辑正确性所以减至2人天，运维需要0.5人天的部署工时，总工时7.5人天，比原开发工时大大提升了效率，节省了人力，加快了交付速度。

本实施例开放平台同时还提供以下服务：

1.访问日志管理

记录每个应用每一次接口访问的数据，包括：访问者客户端信息、访问接口、访问时间、请求出入参，提供日志查询、查看日志明细、按时间和接口统计、报表分析等功能。

2.访问计费功能

针对部分具有商业价值、有投入成本的接口，提供按次、按使用期、按用户收费的模式，并提供计费记录查询、报表功能。

3.限流管理功能

有部分接口调用在一定的时间、调用频率内不具备意义、不会产生任何差异的结果、受业务场景限制、受支持服务的第三方服务限制等原因，需要限制调用频率，统一在开放平台内对接口进行设置，由开放平台统一提供即可。

4.性能监控

接口每次调用需要耗时多久、在一定压力下的访问性能表现如何？在开放平台中统一记录每个接口的每一次调用耗时，并定时输出接口性能分析报告，有助于改善微服务的接口性能。

5.接口文档管理

针对开者订阅的接口、做了接口入参和出参转换的接口，需要针对性的输出对应调整过的接口文档，有助于开发者快速的对接。

6.接口版本管理

开放平台提供接口版本管理，在接口有重大版本升级时，需要保留以前的版本一段时间，让已接入的开发者接口能持续使用，就需要升级接口的版本，让开发者及时升级到新版本，在开放平台建立接口版本管理，为开者提供版本过渡期间的服务。

7.沙箱环境管理

开发者在接入开发阶段，产品还没上线之前，需要一个可以运行的虚拟环境协助产品开发和调式，开放平台提供在沙箱环境中模拟运行，为开发者提供便利。

8.黑白名单管理

开放平台通过配置白名单，使经批准的应用、用户优先通过、快速访问，提高了应用的安全性和快捷性。配置黑名单，把非法入侵者挡在***之外,防范网络攻击，提高了接口的安全性。

实施例4

本实施例提供一种电子设备，包括处理器、存储器以及存储在所述存储器中且被配置为由所述处理器执行的计算机程序，所述存储器与所述处理器耦接，且所述处理器执行所述计算机程序时，实现使用开放平台管理微服务接口方法中的步骤。

综上，本发明实现通过开放平台管理微服务接口后，开发新的业务接口时只需要实现一次业务逻辑，就能快速的支持多个客户端的开发，而且实现微服务接口时，不需要管鉴权、加解密、签名、出入参筛选等流程开放，加快了开发的速度。进入联调和测试时，由于开放平台提供了沙箱环境、访问日志查询、接口性能监控，为测试提供了便利，测试效率也大大提升。部署上线时由于只需要部署一个服务，简化了部署工作。所以从开发到上线，各个环节的效能都得到了提升，加快了产品交付效能，达到敏捷开发、敏捷交付的目的

以上实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。

Claims (10)

1.一种使用开放平台管理微服务接口的方法，其特征在于，包括以下步骤：

S1通过业务微服务为开放平台提供接口，并在需要注册的微服务接口中增加注解；

S2开发者为客户端申请应用，并自动生成应用密钥，客户端通过密钥接入开放平台；

S3开发者接入开放平台接口，核验S2生成的应用密钥后读取应用设置；

S4进行用户鉴权，经判断后自行调用对应的微服务接口，并在输出最终结果后，结束接口调用。

2.根据权利要求1所述的一种使用开放平台管理微服务接口的方法，其特征在于，所述方法中，自动上报接口注册到开放平台，并在开放平台中可重新定义出入参数。

3.根据权利要求1所述的一种使用开放平台管理微服务接口的方法，其特征在于，所述方法中，在注册到开放平台的所有接口中选择订阅需要使用到的业务接口，并设置应用的数据流程。

4.根据权利要求1所述的一种使用开放平台管理微服务接口的方法，其特征在于，所述方法中，应用的设置和接口订阅完成后，提交审核，由管理员审查客户端应用选择的数据流程、接口和相关的参数设置是否合理。

5.根据权利要求1所述的一种使用开放平台管理微服务接口的方法，其特征在于，所述方法中，读取完应用设置后就进行用户鉴权，鉴权通过后，对获取到的应用设置中的验签标识决定是否做验签。

6.根据权利要求5所述的一种使用开放平台管理微服务接口的方法，其特征在于，所述方法中，不需要验签或验签通过后，对获取到的应用设置中的解密标识决定是否做输入数据的解密；

不需要解密或解密数据通过后，就取到了客户端传入的参数，按用户订阅接口的设置检查是否需要转换入参。

7.根据权利要求6所述的一种使用开放平台管理微服务接口的方法，其特征在于，所述方法中，不需要转换入参或转换入参后，得到微服务接口相应的原始入参，开始调用对应的微服务接口；

调用微服务接口后，得到调用结果，按用户订阅接口的设置检查是否需要转换出参。

8.根据权利要求7所述的一种使用开放平台管理微服务接口的方法，其特征在于，所述方法中，不需要转换出参或转换出参后，对获取到的应用设置中的加密标识决定是否需要加密返回数据；

不需要加密或加密数据完成后，对获取到的应用设置中的签名标识决定是否需要加入签名；

不需要加入签名或加签名完成后，输出最终结果，结束接口调用。

9.根据权利要求1所述的一种使用开放平台管理微服务接口的方法，其特征在于，所述方法中，鉴权不通过、校验不正确、验证不正确时都直接转到输出结果，结束接口调用。

10.一种电子设备，其特征在于，包括处理器、存储器以及存储在所述存储器中且被配置为由所述处理器执行的计算机程序，所述存储器与所述处理器耦接，且所述处理器执行所述计算机程序时，实现如权利要求1至9任一项所述的使用开放平台管理微服务接口方法中的步骤。

Images