应用API开放方法及开放平台中程序API管理方法和系统与流程

本发明涉及互联网，特别涉及一种应用api开放方法及开放平台中程序api管理方法和系统，以实现在开放平台快速暴露应用api并利用开放平台对暴露api进行有效管理。

背景技术：

1、开放平台(open platform)是一种基于开放标准和协议的软件或硬件系统，允许第三方开发者创建、定制和集成应用程序、服务或功能。开放平台的目标是促进合作和创新，通过提供开放的接口和工具，使开发者能够构建在该平台上运行的应用程序或扩展。开放平台通常由一个核心系统或产品提供商创建和管理，这个提供商可以是一家公司、组织或开源社区。他们会公开发布有关平台的文档、api(应用程序编程接口)和开发工具，以便第三方开发者可以利用这些资源来构建与平台集成的应用程序。

2、随着开放平台的兴起，越来越多的应用程序需要将其api暴露/开放给外部开发者或应用程序进行集成和调用。然而，传统的api管理和暴露/开放方式存在一些问题，如手动配置api信息，包括手动配置api名称、访问地址等，耗时且容易出错，在大规模应用程序场景下，传统方式无法灵活应对动态增减的应用程序和api，导致管理困难，且缺乏有效的访问控制和数据保护机制，容易受到恶意访问和数据泄露的风险。以上问题制约了开放平台的发展和应用程序的快速接入。

技术实现思路

1、为此，本发明提供一种应用api开放方法及开放平台中程序api管理方法和系统，解决现有api管理和暴露技术中手动配置繁琐、可扩展性差、安全性不足等问题，能够实现在开放平台快速暴露应用api并可利用开放平台对暴露api进行有效管理。

2、按照本发明所提供的设计方案，提供一种应用api开放方法，包含如下内容：

3、在待开放应用api函数中填充开放注解，其中，开放注解的属性包括api接口名称、接口描述、接口版本号和接口扩展参数；

4、在应用启动时解析开放注解，并依据解析结果将应用程序在服务注册中心进行服务注册，以利用开放平台从服务注册中心获取目标应用api。

5、进一步地，在待开放应用api函数中填充开放注解，包括：

6、首先，设置开放注解标识；然后，依据开放注解标识在待开放应用api函数中添加开放注解，并将相关属性内容填充至添加的开放注解属性中，其中，属性内容填充中api接口名称在待开放应用程序函数中保持名称唯一。

7、进一步地，在应用启动时解析开放注解，包括：

8、首先，应用程序在启动时，扫描应用程序所有包含开放注解的函数，解析开放注解属性；

9、然后，利用字典结构保存解析结果，其中，字典结构中key值对应接口名称，value值对应对象，对象内容包括接口描述、接口版本号、接口扩展参数、接口统一资源标识符、接口协议入参及接口协议出参。

10、进一步地，依据解析结果将应用程序在服务注册中心进行服务注册，包括：

11、向服务注册中心提交应用程序服务信息及解析结果，执行应用程序在服务注册中心的服务注册流程，使已在服务注册中心注册的开放平台依据服务列表获取对应服务信息及服务程序api有关数据，其中，服务信息包含服务名称、服务协议、服务ip、服务端口和服务上下文路径

12、结合以上的应用api开放方法，本发明还提供一种开放平台中程序api管理方法，包含如下内容：

13、将开放平台在服务注册中心进行注册，以从服务注册中心获取可用服务列表及对应服务中基于应用api开放方法开放的应用api数据；

14、根据可用服务列表获取对应服务信息，并以对象数组形式将服务对应的应用api数据进行保存，其中，服务信息包含：服务名称、服务协议、服务ip、服务端口及服务上下文路径；

15、依据调用请求获取开放平台中目标服务的服务地址，以获取服务对应所需调用的应用api数据。

16、作为本发明开放平台中程序api管理方法，进一步地，以对象数组形式将服务对应的应用api数据进行保存，包含：

17、首先，由服务协议、服务ip、服务端口及服务上下文路径生成接口统一资源标识符，并依据服务信息得到应用api数据，其中，应用api数据包括：服务接口名称、接口调用方法、接口统一资源标识符、服务名称及接口调用方法内容；

18、然后，依据应用api数据构建对象数据，将服务对应的应用api数据以数组对象形式进行存储。

19、作为本发明开放平台中程序api管理方法，进一步地，还包含：设置服务注册中心扫描时间周期，依据该扫描时间周期定时扫描服务注册中心，检测服务注册中心是否存在服务下线和/或应用api变更情况，若存在，则依据下线的服务及变更的应用api来更新对象数组中相应数据，其中，更新对象数组中相应数据包括删除对象数组中下线服务对应的所述有数据、更新存在变更情况的应用api对应数据。

20、结合以上的应用api开放方法，进一步地，本发明还提供一种开放平台中程序api管理系统，包含：平台注册模块、数据存储模块和数据调用模块，其中，

21、平台注册模块，用于将开放平台在服务注册中心进行注册，以从服务注册中心获取可用服务列表及对应服务中基于应用api开放方法开放的应用api数据；

22、数据存储模块，用于根据可用服务列表获取对应服务信息，并以对象数组形式将服务对应的应用api数据进行保存，其中，服务信息包含：服务名称、服务协议、服务ip、服务端口及服务上下文路径；

23、数据调用模块，用于依据调用请求获取开放平台中目标服务的服务地址，以获取服务对应所需调用的应用api数据。

24、本发明的有益效果：

25、本发明在应用api暴露/开放中通过注解、服务注册等机制，实现自动化的api注册和发现，简化手动配置api信息的繁琐步骤；开放平台应用api管理过程中，通过服务发现、动态更新等机制，大大提高平台的可扩展性，通过开放平台提供的api管理功能，集中管理和维护所有注册的api，方便开发者和应用程序的调用和管理，并可结合api访问鉴权等方式通过访问控制和安全保障措施，防止未授权的访问和数据泄露，降低数据安全等风险问题，增强api的安全性和稳定性。

技术特征：

1.一种应用api开放方法，其特征在于，包含如下内容：

2.根据权利要求1所述的应用api开放方法，其特征在于，在待开放应用api函数中填充开放注解，包括：

3.根据权利要求1所述的应用api开放方法，其特征在于，在应用启动时解析开放注解，包括：

4.根据权利要求3所述的应用api开放方法，其特征在于，依据解析结果将应用程序在服务注册中心进行服务注册，包括：

5.一种开放平台中程序api管理方法，其特征在于，包含如下内容：

6.根据权利要求5所述的开放平台中程序api管理方法，其特征在于，以对象数组形式将服务对应的应用api数据进行保存，包含：

7.根据权利要求1或5所述的开放平台中程序api管理方法，其特征在于，还包含：设置服务注册中心扫描时间周期，依据该扫描时间周期定时扫描服务注册中心，检测服务注册中心是否存在服务下线和/或应用api变更情况，若存在，则依据下线的服务及变更的应用api来更新对象数组中相应数据，其中，更新对象数组中相应数据包括删除对象数组中下线服务对应的所述有数据、更新存在变更情况的应用api对应数据。

8.一种开放平台中程序api管理系统，其特征在于，包含：平台注册模块、数据存储模块和数据调用模块，其中，

9.一种电子设备，其特征在于，包括存储器和处理器，所述处理器和所述存储器通过总线完成相互间的通信；所述存储器存储有可被所述处理器执行的程序指令，所述处理器调用所述程序指令能够执行如权利要求1～4任一项所述的方法。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质内存储有计算机程序，所述计算机程序被处理器执行时实现权利要求1～4任一项所述的方法。

技术总结
本发明涉及互联网技术领域，特别涉及一种应用API开放方法及开放平台中程序API管理方法和系统，在待开放应用API函数中填充开放注解，其中，开放注解的属性包括API接口名称、接口描述、接口版本号和接口扩展参数；在应用启动时解析开放注解，并依据解析结果将应用程序在服务注册中心进行服务注册，以利用开放平台从服务注册中心获取目标应用API。本发明在应用API暴露/开放中通过注解、服务注册等机制，实现自动化的API注册和发现，简化手动配置API信息的繁琐步骤；开放平台应用API管理过程中，通过服务发现、动态更新等机制，提高平台的可扩展性，通过开放平台提供的API管理功能，集中管理和维护所有注册的API，方便开发者和应用程序的调用和管理。

技术研发人员：曾伟,孟旭,郝亮,牛智鹏,余松海,崔灿,孙红亮,杨春,王红,李江巍,王一,随志辉,陈龙浩,李福明,段素霞
受保护的技术使用者：数字郑州科技有限公司
技术研发日：
技术公布日：2024/1/15