一种接口文档管理系统及其工作方法技术方案

本发明专利技术提供了一种接口文档管理系统及其工作方法，涉及信息安全技术，该系统包括：应用程序和接口中心；应用程序，用于将业务逻辑实现，提供接口生成接口文档；接口中心，用于接收应用程序的接口文档并进行文档资源管理；应用程序，包括：集成模块和监控模块；集成模块，用于对业务逻辑实现的代码集成，通过对底层API重构方式，定义自定义注解，扫描应用程序接口代码并收集接口数据，生成接口文档至缓存，提供文档接口调用；监控模块，用于监控应用程序接口代码变动情况，缓存接口文档内容，在接口代码变动时自动更新接口文档以及更新存储在接口中心的文档资源。通过对底层API重构方式，屏蔽底层细节，支持各种类型接口文档生成和实时更新。

【技术实现步骤摘要】
一种接口文档管理系统及其工作方法
本专利技术涉及计算机数据处理
，具体涉及信息安全技术，尤其涉及一种接口文档管理系统及其工作方法。
技术介绍
本部分旨在为权利要求书中陈述的本专利技术的实施方式提供背景或上下文。此处的描述不因为包括在本部分中就承认是现有技术。目前随着应用不断扩展，业务逻辑变重，导致会拆分成很多服务接口以及Restful、RPC等不同类型的接口来实现调用不同的业务功能，对于开发调试来说若接口文档不可缺少，偌大的接口就需要一个专门用于管理接口文档的地方。目前业界管理不同的接口类型的文档管理都是基于Swagger实现的且相互独立的方式，没有一套统一实现管理各种类型的接口文档的展示和内容更新，应用也无法进行自定义参数来收集更多的指标内容。因此，如何提供一种新的方案，其能够解决上述技术问题是本领域亟待解决的技术难题。
技术实现思路
本专利技术实施例提供一种接口文档管理系统，通过对底层API重构方式，屏蔽底层细节，抽取成一套支持多种接口的统一注解，应用只需要引入一套依赖并使用同一套注解即可能支持各种类型接口的文档生成和实时更新，该系统包括：应用程序和接口中心；应用程序，用于将业务逻辑实现，提供接口生成接口文档；接口中心，用于接收应用程序的接口文档并进行文档资源管理；应用程序，包括：集成模块和监控模块；集成模块，用于对业务逻辑实现的代码集成，通过对底层API重构方式，定义自定义注解，扫描应用程序接口代码并收集接口数据，生成接口文档至缓存，提供文档接口调用；监控模块，用于监控应用程序接口代码变动情况，缓存接口文档内容，在接口代码变动时自动更新接口文档以及更新存储在接口中心的文档资源。本专利技术实施例还提供一种接口文档管理系统的工作方法，包括：应用程序将业务逻辑实现，提供接口生成接口文档；接口中心接收应用程序的接口文档并进行文档资源管理；集成模块对业务逻辑实现的代码集成，通过对底层API重构方式，定义自定义注解，扫描应用程序接口代码并收集接口数据，生成接口文档至缓存，提供文档接口调用；监控模块监控应用程序接口代码变动情况，缓存接口文档内容，在接口代码变动时自动更新接口文档以及更新存储在接口中心的文档资源。本专利技术实施例还提供一种计算机设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现上述一种接口文档管理系统的工作方法。本专利技术实施例还提供一种计算机可读存储介质，所述计算机可读存储介质存储有执行上述一种接口文档管理系统的工作方法的计算机程序。本专利技术实施例提供的一种接口文档管理系统及其工作方法，包括：应用程序和接口中心；应用程序，用于将业务逻辑实现，提供接口生成接口文档；接口中心，用于接收应用程序的接口文档并进行文档资源管理；应用程序，包括：集成模块和监控模块；集成模块，用于对业务逻辑实现的代码集成，通过对底层API重构方式，定义自定义注解，扫描应用程序接口代码并收集接口数据，生成接口文档至缓存，提供文档接口调用；监控模块，用于监控应用程序接口代码变动情况，缓存接口文档内容，在接口代码变动时自动更新接口文档以及更新存储在接口中心的文档资源。本专利技术通过对底层API重构方式，屏蔽底层细节，抽取成一套支持多种接口的统一注解，应用只需要引入一套依赖并使用同一套注解即可能支持各种类型接口的文档生成和实时更新。同时支持多种接口类型API文档生成，能动态精准监控接口代码内容的变动捕获，非接口代码内容变动不进行捕获，生成实时新的接口文档并自动更新，提供文档接口API，方便外界调用查询、下载接口文档。附图说明为了更清楚地说明本专利技术实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本专利技术的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。在附图中：图1为本专利技术实施例一种接口文档管理系统示意图。图2为本专利技术实施例一种接口文档管理系统监控模块内部结构图，图3为本专利技术实施例一种接口文档管理系统集成模块内部原理执行过程流程图。图4为本专利技术实施例一种接口文档管理系统的工作方法示意图。图5为运行本专利技术实施的一种接口文档管理系统的工作方法的计算机装置示意图。具体实施方式为使本专利技术实施例的目的、技术方案和优点更加清楚明白，下面结合附图对本专利技术实施例做进一步详细说明。在此，本专利技术的示意性实施例及其说明用于解释本专利技术，但并不作为对本专利技术的限定。图1为本专利技术实施例一种接口文档管理系统示意图，如图1所示，本专利技术实施例提供一种接口文档管理系统，通过对底层API重构方式，屏蔽底层细节，抽取成一套支持多种接口的统一注解，应用只需要引入一套依赖并使用同一套注解即可能支持各种类型接口的文档生成和实时更新，该系统包括：应用程序和接口中心；应用程序，用于将业务逻辑实现，提供接口生成接口文档；接口中心，用于接收应用程序的接口文档并进行文档资源管理；应用程序，包括：集成模块和监控模块；集成模块，用于对业务逻辑实现的代码集成，通过对底层API重构方式，定义自定义注解，扫描应用程序接口代码并收集接口数据，生成接口文档至缓存，提供文档接口调用；监控模块，用于监控应用程序接口代码变动情况，缓存接口文档内容，在接口代码变动时自动更新接口文档以及更新存储在接口中心的文档资源。本专利技术实施例提供的一种接口文档管理系统，包括：应用程序和接口中心；应用程序，用于将业务逻辑实现，提供接口生成接口文档；接口中心，用于接收应用程序的接口文档并进行文档资源管理；应用程序，包括：集成模块和监控模块；集成模块，用于对业务逻辑实现的代码集成，通过对底层API重构方式，定义自定义注解，扫描应用程序接口代码并收集接口数据，生成接口文档至缓存，提供文档接口调用；监控模块，用于监控应用程序接口代码变动情况，缓存接口文档内容，在接口代码变动时自动更新接口文档以及更新存储在接口中心的文档资源。本专利技术通过对底层API重构方式，屏蔽底层细节，抽取成一套支持多种接口的统一注解，应用只需要引入一套依赖并使用同一套注解即可能支持各种类型接口的文档生成和实时更新。同时支持多种接口类型API文档生成，能动态精准监控接口代码内容的变动捕获，非接口代码内容变动不进行捕获，生成实时新的接口文档并自动更新，提供文档接口API，方便外界调用查询、下载接口文档。本专利技术实施例提供的一种接口文档管理系统，涉及程序底层代码设计领域，尤其涉及一种基于Swagger实现的接口文档管理方法。参照图1，具体实施本专利技术实施例提供的一种接口文档管理系统时，在一个实施例中，该系统包括：应用程序和接口中心；应用程序，用于将业务逻辑实现，提供接口生成接口文档；接口中心，用于接收应用程序的接口文档并进行文档资源管理；应用程序，包括：集成模块和监控模块；本文档来自技高网...

【技术保护点】
1.一种接口文档管理系统，其特征在于，包括：应用程序和接口中心；/n应用程序，用于将业务逻辑实现，提供接口生成接口文档；接口中心，用于接收应用程序的接口文档并进行文档资源管理；/n应用程序，包括：集成模块和监控模块；/n集成模块，用于对业务逻辑实现的代码集成，通过对底层API重构方式，定义自定义注解，扫描应用程序接口代码并收集接口数据，生成接口文档至缓存，提供文档接口调用；/n监控模块，用于监控应用程序接口代码变动情况，缓存接口文档内容，在接口代码变动时自动更新接口文档以及更新存储在接口中心的文档资源。/n

【技术特征摘要】
1.一种接口文档管理系统，其特征在于，包括：应用程序和接口中心；
应用程序，用于将业务逻辑实现，提供接口生成接口文档；接口中心，用于接收应用程序的接口文档并进行文档资源管理；
应用程序，包括：集成模块和监控模块；
集成模块，用于对业务逻辑实现的代码集成，通过对底层API重构方式，定义自定义注解，扫描应用程序接口代码并收集接口数据，生成接口文档至缓存，提供文档接口调用；
监控模块，用于监控应用程序接口代码变动情况，缓存接口文档内容，在接口代码变动时自动更新接口文档以及更新存储在接口中心的文档资源。


2.如权利要求1所述的系统，其特征在于，监控模块，包括：监听器模块，数据处理模块，通讯功能模块；
监听器模块，用于监听扫描应用程序的接口代码变动情况，传递给数据处理模块；
数据处理模块，用于根据监听器模块传递来的接口代码变动情况触发，计算接口变动的代码内容比较，扫描并计算变动情况是否是接口、服务调用的函数变动情况，确认更新接口、服务调用内容，反馈给集成模块，让集成模块重新生成一份新的接口文档并缓存；
通讯功能模块，用于封装接口文档内容，自动更新接口文档以及更新存储在接口中心的文档资源。


3.如权利要求2所述的系统，其特征在于，监听器模块，具体用于：
监听扫描应用程序的接口代码，获取接口代码变动情况；
根据接口代码变动情况，比对缓存的接口和服务调用代码，确定对比变动数据，传递给数据处理模块。


4.如权利要求2所述的系统，其特征在于，通讯功能模块，具体用于：
从集成模块中获取缓存的接口文档，得到接口文档内容；
将接口文档内容封装成更新内容，露出Http接口给外界调用查询或者下载接口文档，通过更新内容自动更新接口文档；
将更新后的接口文档传递给接口中心替换旧版文档，对接口中心的文档资源进行更新。


5.一种接口文档管理系统的工作方法，其特征在于，包括：
应用程序将业务逻辑实现，提供接口生成接口文档；接口中心接收应用程序的接口文档并进行文档资源管理；
集成模块对业务逻辑实现的代码集成，通过对底层API重构方...

【专利技术属性】
技术研发人员：吴成龙，施生燊，徐克宝，隋臣，
申请(专利权)人：中国工商银行股份有限公司，
类型：发明
国别省市：北京;11