一种API元数据处理方法、装置以及设备制造方法及图纸

本说明书实施例公开了一种API元数据处理方法、装置以及设备。方案包括：获取Java代码，并从所述Java代码中解析得到API元数据；确定根据自定义协议字段构建的JSON Schema结构，所述自定义协议字段下包含适应于其指示的协议能够相较于其他协议差异化定义的多个子字段；利用所述JSON Schema结构，存储所述API元数据，以便使用。以便使用。以便使用。

【技术实现步骤摘要】
一种API元数据处理方法、装置以及设备


[0001]本说明书涉及编程接口
，尤其涉及一种API元数据处理方法、装置以及设备。

技术介绍

[0002]随着互联网技术的迅速发展和智能手机的使用普及，涌现出越来越多的大中型体量的应用，这些应用的用户规模较大，功能也越来越多和复杂，从而在研发过程中也涉及到越来越多的应用程序编程接口(Application Programming Interface，API)。
[0003]在实际应用中，API的设计和管理通常需要使用文档或者其他手动方式进行记录和维护，然而，这些方式往往会导致不一致、缺失以及难以维护等问题，从而影响研发效率，还有可能给应用的运行带来风险。
[0004]基于此，需要更为可靠的API管理维护方案。

技术实现思路

[0005]本说明书一个或多个实施例提供一种API元数据处理方法、装置、设备以及存储介质，用以解决如下技术问题：需要更为可靠的API管理维护方案。
[0006]为解决上述技术问题，本说明书一个或多个实施例是这样实现的：
[0007]本说明书一个或多个实施例提供的一种API元数据处理方法，包括：
[0008]获取Java代码，并从所述Java代码中解析得到API元数据；
[0009]确定根据自定义协议字段构建的JSON Schema结构，所述自定义协议字段下包含适应于其指示的协议能够相较于其他协议差异化定义的多个子字段；
[0010]利用所述JSON Schema结构，存储所述API元数据，以便使用。
[0011]本说明书一个或多个实施例提供的一种API元数据处理装置，包括：
[0012]API元数据获取模块，获取Java代码，并从所述Java代码中解析得到API元数据；
[0013]Schema结构确定模块，确定根据自定义协议字段构建的JSON Schema结构，所述自定义协议字段下包含适应于其指示的协议能够相较于其他协议差异化定义的多个子字段；
[0014]API元数据存储模块，利用所述JSON Schema结构，存储所述API元数据，以便使用。
[0015]本说明书一个或多个实施例提供的一种API元数据处理设备，包括：
[0016]至少一个处理器；以及，
[0017]与所述至少一个处理器通信连接的存储器；其中，
[0018]所述存储器存储有可被所述至少一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够：
[0019]获取Java代码，并从所述Java代码中解析得到API元数据；
[0020]确定根据自定义协议字段构建的JSON Schema结构，所述自定义协议字段下包含适应于其指示的协议能够相较于其他协议差异化定义的多个子字段；
[0021]利用所述JSON Schema结构，存储所述API元数据，以便使用。
[0022]本说明书一个或多个实施例提供的一种非易失性计算机存储介质，存储有计算机可执行指令，所述计算机可执行指令设置为：
[0023]获取Java代码，并从所述Java代码中解析得到API元数据；
[0024]确定根据自定义协议字段构建的JSON Schema结构，所述自定义协议字段下包含适应于其指示的协议能够相较于其他协议差异化定义的多个子字段；
[0025]利用所述JSON Schema结构，存储所述API元数据，以便使用。
[0026]本说明书一个或多个实施例采用的上述至少一个技术方案能够达到以下有益效果：采用了半结构化的JSON Schema结构来存储API元数据，并且可以通过自定义协议字段及其下包含的能够更细粒度区分协议的多个子字段，来自由灵活地描述采用标准协议的接口和采用自定义协议的接口，从而能够更完整更准确地管理维护API元数据，进而有助于更好管理、设计、调试以及维护API。
附图说明
[0027]为了更清楚地说明本说明书实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本说明书中记载的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。
[0028]图1为本说明书一个或多个实施例提供的一种API元数据处理方法的流程示意图；
[0029]图2为本说明书一个或多个实施例提供的一种对API元数据存储后的使用方式示意图；
[0030]图3为本说明书一个或多个实施例提供的一种实际应用场景下，用于存储API元数据的JSON Schema结构中的关键改进点的示意图；
[0031]图4为本说明书一个或多个实施例提供的一种API元数据处理装置的结构示意图；
[0032]图5为本说明书一个或多个实施例提供的一种API元数据处理设备的结构示意图。
具体实施方式
[0033]本说明书实施例提供一种API元数据处理方法、装置、设备以及存储介质。
[0034]为了使本
的人员更好地理解本说明书中的技术方案，下面将结合本说明书实施例中的附图，对本说明书实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本申请一部分实施例，而不是全部的实施例。基于本说明书实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都应当属于本申请保护的范围。
[0035]正如
技术介绍
中介绍的那样，不仅是移动端的应用，在现代软件研发中，API已经成为不可或缺组成部分之一，因此，在如何更好地管理、设计、调试以及维护API，这个领域里探索出更加高效、可靠的方案具有非常重要的意义。API指的是，应用程序编程接口，在软件开发中通常指对外提供服务或功能的编程接口，通过API这类接口，不同系统之间可以进行交互并共享资源、数据等信息。
[0036]
技术介绍
中提到方式申请人也尝试过，通过公司内文档或其他手动方式，来维护API元数据，但是，实际感受是这些方式效率低下，文档往往无法及时更新，久而久之，API元
数据就会疏于维护，导致研发效率、研发质量下降。
[0037]有鉴于此，申请人又尝试采用Swagger Schema来描述API，其支持多种数据类型、属性以及约束等功能，是用于描述RESTful API的数据模型和结构。但是，这种方案局限性很大，主要体现在以下三方面：
[0038]第一、只能描述采用HTTP协议的API，而在实际应用中，很多企业内部会使用各种非标准的自定义协议，以满足自己产品的特殊需求，在这种情况下，所定义和使用的API或其他接口往往也会大规模地基于这些自定义协议，从而导致方案适用性远远不够。HTTP即超文本传输协议，是一种网络协议，主要用于Web应用程序之间传输超文本文档或其他资源文件。HTTP协议采用客户端
‑
服务器模式进行通信，并且支持多种请求方法如GET、POST等方式进行本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种API元数据处理方法，包括：获取Java代码，并从所述Java代码中解析得到API元数据；确定根据自定义协议字段构建的JSON Schema结构，所述自定义协议字段下包含适应于其指示的协议能够相较于其他协议差异化定义的多个子字段；利用所述JSON Schema结构，存储所述API元数据，以便使用。2.如权利要求1所述的方法，所述利用所述JSON Schema结构，存储所述API元数据之后，所述方法还包括：读取出以所述JSON Schema结构存储的所述API元数据，通过渲染器渲染得到在线的API文档。3.如权利要求1所述的方法，所述Java代码为后端Java代码；所述利用所述JSON Schema结构，存储所述API元数据之后，所述方法还包括：根据以所述JSON Schema结构存储的所述API元数据，生成使用对应的API的前端消费代码。4.如权利要求1所述的方法，所述确定根据自定义协议字段构建的JSON Schema结构，具体包括：确定自定义协议字段所针对的一种或多种自定义接口协议；确定为所述自定义接口协议设计的通用信息子字段和能够差异化定义的编程语言相关的元信息子字段；确定根据所述通用信息子字段和所述编程语言相关的元信息子字段构建的JSON Schema结构。5.如权利要求4所述的方法，所述编程语言相关的元信息子字段包括以下至少一种：接口所属的数据包的包名子字段、接口所属的项目的项目名称子字段、接口的唯一标识子字段。6.如权利要求4所述的方法，自定义接口协议包括一下至少一种：对RPC协议进行再封装得到的第一自定义协议；自定义网关协议。7.如权利要求1所述的方法，所述确定根据自定义协议字段构建的JSON Schema结构，具体包括：确定为接口用到的对象定义的泛型支持扩展字段，所述泛型支持扩展字段下包含多个泛型结构定义描述子字段；确定根据自定义协议字段和所述泛型支持扩展字段构建的JSON Schema结构。8.如权利要求7所述的方法，所述利用所述JSON Schema结构，存储所述API元数据，具体包括：获取所述API元数据对应的编程代码中对泛型的使用和定义数据，所述使用和定义数据至少包括参数名称和参数位置；利用所述多个泛型结构定义描述子字段，对所述使用和定义数据进行存储。9.一种API元数据处理装置，包括：API元数据获取模块，获取Java代码，并从所述Java代码中解析得到API元数据；Schema结构确定模块，确定根据自定义协议字段构建的JSON Schema结构，所述自定义协议字段下包含适应于其指示的协议能够相较于其他协...

【专利技术属性】
技术研发人员：邬文怀，
申请(专利权)人：支付宝杭州信息技术有限公司，
类型：发明
国别省市：