接口文档管理方法、系统、计算机设备和存储介质技术方案

本发明专利技术提供了一种接口文档管理方法，所述方法包括，获取项目的配置文件；按所述项目的配置文件通过预设jar包中的接口文档生成工具生成符合预设规范的接口文档；通过所述项目的服务名获取所述项目的接口文档并进行聚合；生成一个对所述项目的接口文档聚合后的查询接口，由于通过统一规定接口文档的格式，只需通过项目的服务名，从注册中心中直接获取文档接口，进而获取接口文档聚合，因此，可以实现在各种项目背景下接口文档的聚合的效果。种项目背景下接口文档的聚合的效果。种项目背景下接口文档的聚合的效果。

【技术实现步骤摘要】
接口文档管理方法、系统、计算机设备和存储介质


[0001]本申请涉及接口文档管理
，特别是涉及一种接口文档管理方法、系统、计算机设备和存储介质。

技术介绍

[0002]常用的接口文档技术swagger本身并不支持聚合功能，需要网关服务来整合各个微服务的文档，但是开发的实际情况中可能并不希望网关中添加过多的功能，或者说甚至可能没有网关服务，各个微服务并不在一个网关下的话，整合起来变得就十分困难。其他整合技术例如knife4j Aggregation支持单独启动一个服务来聚合文档，预先配置好各个要聚合的服务swagger文档地址，自己做路由分发。但是此方案并不完善，不支持现在主流的kubernetes服务注册发现，并且不支持动态的加载新服务的文档，每次有新服务要重新配置重启服务，文档上并不能很好的看出各个接口的校验规则。
[0003]因此，如何提供一种能整合不同网关的接口文档进行聚合的文档管理方法成了亟待解决的问题。

技术实现思路

[0004]本专利技术实施例提供了一种接口文档管理法、系统、计算机设备和存储介质，以至少解决相关技术中文档聚合的问题。
[0005]根据本专利技术的一个实施例，提供了一种接口文档管理方法，所述方法包括：
[0006]获取项目的配置文件；
[0007]按所述项目的配置文件通过预设jar包中的接口文档生成工具生成符合预设规范的接口文档；
[0008]通过所述项目的服务名获取所述项目的接口文档并进行聚合；
[0009]生成一个对所述项目的接口文档聚合后的查询接口。
[0010]进一步地，所述预设jar包还包含校验SDK包，所述校验SDK包内预设有校验框架，将所述校验框架引入至所述接口文档内，在所述接口文档需要校验的字段生成校验信息。
[0011]进一步地，所述通过所述项目的服务名获取所述项目的接口文档并进行聚合，具体包括：
[0012]所述聚合为基于Servlet的拦截技术实现聚合。
[0013]进一步地，所述基于Servlet的拦截技术实现聚合，具体包括：
[0014]使用所述项目的服务名在注册中心中获取所述项目的接口文档的地址；
[0015]根据所述项目的接口文档的地址，向所述项目的文档接口发送获取请求，获取所述项目的接口文档；
[0016]对所述项目的接口文档进行聚合。
[0017]进一步地，所述使用所述项目的服务名在注册中心中获取所述项目的接口文档的地址，具体包括：
[0018]按预设时间动态获取注册中心的服务列表，查询现有项目的服务名，获取接口文档，并将所述接口文档加载到本地的配置缓存内。
[0019]进一步地，所述预设时间为五分钟。
[0020]根据本专利技术的另一个实施例，提供了一种接口文档管理系统，所述系统包括：
[0021]获取模块：获取项目的配置文件；
[0022]生成模块：按所述项目的配置文件通过预设jar包中的接口文档生成工具生成符合预设规范的接口文档；
[0023]聚合模块：通过所述项目暴露的接口获取所述项目的接口文档并进行聚合；
[0024]查询接口模块：生成一个对所述项目的接口文档聚合后的查询接口。
[0025]根据本专利技术的又一个实施例，还提供了一种计算机设备，包括存储器和处理器，所述处理器与存储器耦合，所述存储器中存储有至少一条程序指令或代码，所述至少一条程序指令或代码由所述处理器加载并执行，以使所述计算机设备实现接口文档管理方法。
[0026]根据本专利技术的又一个实施例，还提供了一种计算机可读存储介质，其上存储有计算机程序，其特征在于，所述计算机程序被执行时实现接口文档管理方法中任一项所述的方法的步骤。
[0027]通过本专利技术，由于通过统一规定接口文档的格式，只需通过项目的服务名，从注册中心中直接获取文档接口，进而获取接口文档聚合，因此，可以实现在各种项目背景下接口文档的聚合的效果。
附图说明
[0028]此处所说明的附图用来提供对本专利技术的进一步理解，构成本申请的一部分，本专利技术的示意性实施例及其说明用于解释本专利技术，并不构成对本专利技术的不当限定。在附图中：
[0029]图1为本申请实施例提供的一种接口文档管理方法的架构图；
[0030]图2为本申请的应用环境的示意图；
[0031]图3为一个实施例中的一种接口文档管理方法的流程示意图；
[0032]图4为一个实施例中API搜索的示意图；
[0033]图5为一个实施例中文档校验的示意图
[0034]图6为一个实施例中计算机设备的示意性结构框图。
具体实施方式
[0035]下面将结合本申请实施例中的附图，对本申请实施例中的技术方案进行描述，显然，所描述的实施例仅仅是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。
[0036]请参阅图1，为本申请实施例提供的一种接口文档管理系统的一个架构图,
[0037]其中，该USER可以是计算机设备，例如服务器，台式计算机，笔记本电脑等，或者还可以是其他具有处理功能的设备，具体此处不做限定。
[0038]需要说明的是，在实际应用过程中，该接口文档管理系统还可以包括更多的设备。例如，还可以包括用户设备，在需要使用该接口文档管理系统时，用户设备会通过获取配置
文件生成接口文档，在从用户设备的储存器中通过用户名获取文档接口。
[0039]基于上述图1所示的接口文档管理系统架构，以下对本申请实施例中的方法作详细说明。
[0040]本申请提供的接口文档管理方法，可以全部在服务器一侧执行，也可以全部在客户端一侧执行，还可以由服务器和客户端共同执行。在接口文档管理方法由服务器和客户端共同执行时，可以应用于如图2所示的应用环境中。其中，客户端102与服务器104通过网络进行通信。
[0041]服务器104可以获取到终端102的接口文档，且服务器104可以执行通过项目的服务名获取项目的接口文档并进行聚合，生成一个对项目的接口文档聚合后的查询接口。
[0042]其中，客户端102执行获取项目的配置文件，按项目的配置文件通过预设jar包中的接口文档生成工具生成符合预设规范的接口文档。
[0043]其中，客户端102可以但不限于是各种计算机、笔记本电脑、智能手机、平板电脑和便携式智能设备，服务器104可以用独立的服务器或者是多个服务器组成的服务器集群来实现。
[0044]请参阅图3，为本申请实施例提供的接口文档管理方法一个流程示意图，包括以下步骤：
[0045]S301：获取项目的配置文件；
[0046]具体的，由项目人员编写符合自己项目的配置文件。
[0047]S302：按项目的配置文件通过预设jar包中的接口文档生成工具生成符合预设规范的接口文档；
本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档管理方法，其特征在于，所述方法包括：获取项目的配置文件；按所述项目的配置文件通过预设jar包中的接口文档生成工具生成符合预设规范的接口文档；通过所述项目的服务名获取所述项目的接口文档并进行聚合；生成一个对所述项目的接口文档聚合后的查询接口。2.根据权利要求1所述的方法，其特征在于：所述预设jar包还包含校验SDK包，所述校验SDK包内预设有校验框架，将所述校验框架引入至所述接口文档内，在所述接口文档需要校验的字段生成校验信息。3.根据权利要求1所述的方法，其特征在于：通过所述项目的服务名获取所述项目的接口文档并进行聚合，具体包括：所述聚合为基于Servlet的拦截技术实现聚合。4.根据权利要求3所述的方法，其特征在于：所述基于Servlet的拦截技术实现聚合，具体包括：使用所述项目的服务名在注册中心中获取所述项目的接口文档的地址；根据所述项目的接口文档的地址，向所述项目的文档接口发送获取请求，获取所述项目的接口文档；对所述项目的接口文档进行聚合。5.根据权利要求4所述的方法，其特征在于：所述使用所述项目的服务名在注册中...

【专利技术属性】
技术研发人员：蒋晓琛，
申请(专利权)人：上海芯赛云计算科技有限公司，
类型：发明
国别省市：