接口文档生成方法、装置、非易失性存储介质和电子设备制造方法及图纸

本申请公开了一种接口文档生成方法、装置、非易失性存储介质和电子设备。涉及金融科技领域，该方法包括：为微服务系统中的微服务应用创建接口应用，其中，微服务系统包括接口应用，接口应用被配置为Web应用；接收访问请求，其中，访问请求用于表征请求访问微服务应用的接口文档；响应于访问请求，基于接口应用获取微服务应用的第一接口数据；根据第一接口数据，生成接口文档。通过本申请，解决了相关技术中由于需要将微服务应用改造为Web项目才能生成接口文档造成的接口文档生成方法限制性强的技术问题。强的技术问题。强的技术问题。

【技术实现步骤摘要】
接口文档生成方法、装置、非易失性存储介质和电子设备


[0001]本专利技术涉及金融科技领域，具体而言，涉及一种接口文档生成方法、装置、非易失性存储介质和电子设备。需要说明的是，本专利技术确定的接口文档生成方法、装置、非易失性存储介质和电子设备可用于金融科技领域生成接口文档，也可用于除金融科技领域之外的任意领域生成接口文档，本专利技术涉及的接口文档生成方法、装置、非易失性存储介质和电子设备的应用领域不做限定。

技术介绍

[0002]目前生成接口文档的方案都通过添加扫描组件的方式，在项目构建工具的编译时期对接口进行扫描，并获得接口数据的JSON(JavaScript Object Notation)文件，根据接口数据生成接口文档并展示，便于开发人员调试接口。
[0003]现有技术为注册中心中的微服务应用提供接口文档生成功能时，需要微服务应用的接口数据和用于构建展示接口文档的调试页面的静态资源，其中，静态资源包括超文本标记语言(html)、网页脚本语言(javascript)、层叠样式表(css)、图片文件等。
[0004]注册中心包括的微服务应用A想要启动接口文档时，首先需要将自身引入相关的Java归档文件(jar包)，并额外添加依赖等(例如spring
‑
web文件)，成为Web项目。当微服务应用A启动时，会全项目扫描接口数据，利用静态资源(包括html、javascript、css、图片文件等)搭建接口文档调试页面，并依据刚才扫描到的接口数据，进行展示。注册中心包括的微服务应用B、C等想要启动接口文档，也是相同的加载过程。其中，spring
‑
web文件是spring框架下的用于支持Web开发的文件。
[0005]现有的生成接口文档的方案要求每个微服务应用都成为一个Web项目。如果有些微服务应用的业务本身不涉及Web，就不适合生成接口文档。
[0006]针对相关技术中由于需要将微服务应用改造为Web项目才能生成接口文档造成的接口文档生成方法限制性强的技术问题，目前尚未提出有效的解决方案。

技术实现思路

[0007]本专利技术实施例提供了一种接口文档生成方法、装置、非易失性存储介质和电子设备，以至少解决由于需要将微服务应用改造为Web项目才能生成接口文档造成的接口文档生成方法限制性强的技术问题。
[0008]为了实现上述目的，根据本申请的一个方面，提供了一种接口文档生成方法。该方法包括：为微服务系统中的微服务应用创建接口应用，其中，微服务系统包括接口应用，接口应用被配置为Web应用；接收访问请求，其中，访问请求用于表征请求访问微服务应用的接口文档；响应于访问请求，基于接口应用获取微服务应用的第一接口数据；根据第一接口数据，生成接口文档。
[0009]可选地，基于接口应用获取微服务应用的第一接口数据，包括：基于接口应用获取微服务应用在当前时刻的上一时刻下的第二接口数据，其中，当前时刻为获取第一接口数
据的时刻；基于接口应用确定第二接口数据在上一时刻和当前时刻之间的变化数据；根据变化数据，更新第二接口数据，得到第一接口数据。
[0010]可选地，确定第二接口数据在上一时刻和当前时刻之间的变化数据，包括：根据扫描微服务应用的代码得到的代码的注释，确定第二接口数据在上一时刻和当前时刻之间的变化数据，并采用远程调用技术将变化数据发送至接口应用。
[0011]可选地，确定第二接口数据在上一时刻和当前时刻之间的变化数据，还包括：在当前时刻下，基于打包插件将微服务应用打包，得到第一打包文件，在上一时刻下，基于打包插件将微服务应用打包，得到第二打包文件，其中，第一打包文件包括第一接口数据，第二打包文件包括第二接口数据；将第一打包文件和第二打包文件保存在预先配置的本地路径指示的位置处；接口应用通过本地路径读取第一打包文件和第二打包文件，确定第二接口数据在上一时刻和当前时刻之间的变化数据。
[0012]可选地，确定第二接口数据在上一时刻和当前时刻之间的变化数据，还包括：接口应用读取代码仓库中微服务应用的代码中包含的注释，确定第二接口数据在上一时刻和当前时刻之间的变化数据，其中，代码仓库中存储微服务应用的代码。
[0013]可选地，根据第一接口数据，生成接口文档，包括：根据预存在接口应用中的静态资源，搭建接口文档的调试界面；在调试界面上展示第一接口数据，生成接口文档。
[0014]可选地，还包括：响应于访问N个微服务应用的访问请求，基于接口应用获取N个微服务应用各自的接口数据，其中，N为大于1的整数；根据N个微服务应用各自的接口数据，生成N个微服务应用各自的接口文档。
[0015]为了实现上述目的，根据本申请的另一方面，提供了一种接口文档生成装置。该装置包括：创建模块，用于为微服务系统中的微服务应用创建接口应用，其中，微服务系统包括接口应用，接口应用被配置为Web应用；接收模块，用于接收访问请求，其中，访问请求用于表征请求访问微服务应用的接口文档；响应模块，用于响应于访问请求，基于接口应用获取微服务应用的第一接口数据；生成模块，用于根据第一接口数据，生成接口文档。
[0016]为了实现上述目的，根据本申请的另一方面，提供了一种非易失性存储介质，非易失性存储介质包括存储的程序，其中，在程序运行时控制非易失性存储介质所在设备上述中任意一项的接口文档生成方法。
[0017]为了实现上述目的，根据本申请的另一方面，提供了一种电子设备，包括一个或多个处理器和存储器，存储器用于存储一个或多个程序，其中，当一个或多个程序被一个或多个处理器执行时，使得一个或多个处理器实现上述中任意一项的接口文档生成方法。
[0018]通过本申请，采用以下步骤：为微服务系统中的微服务应用创建接口应用，其中，微服务系统包括接口应用，接口应用被配置为Web应用；接收访问请求，其中，访问请求用于表征请求访问微服务应用的接口文档；响应于访问请求，基于接口应用获取微服务应用的第一接口数据；根据第一接口数据，生成接口文档，达到了为需要生成接口文档的微服务应用创建用于生成接口文档的接口应用的目的，解决了相关技术中由于需要将微服务应用改造为Web项目才能生成接口文档造成的接口文档生成方法限制性强的技术问题，进而达到了降低接口文档生成方法限制性的技术效果。
附图说明
[0019]构成本申请的一部分的附图用来提供对本申请的进一步理解，本申请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中：
[0020]图1是根据现有技术提供的接口文档生成方法的示意图；
[0021]图2是根据本申请实施例提供的接口文档生成方法的流程图；
[0022]图3是根据本申请可选实施例提供的接口文档生成方法的示意图；
[0023]图4是根据本申请实施例提供的接口文档生成装置的示意图；
[0024]图5是根据本专利技术实施例提供的用于进行接口文档生成方法的电子设备的结构示意图。
具体实施方式
[0025本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档生成方法，其特征在于，包括：为微服务系统中的微服务应用创建接口应用，其中，所述微服务系统包括所述接口应用，所述接口应用被配置为Web应用；接收访问请求，其中，所述访问请求用于表征请求访问所述微服务应用的接口文档；响应于所述访问请求，基于所述接口应用获取所述微服务应用的第一接口数据；根据所述第一接口数据，生成所述接口文档。2.根据权利要求1所述的方法，其特征在于，所述基于所述接口应用获取所述微服务应用的第一接口数据，包括：基于所述接口应用获取所述微服务应用在当前时刻的上一时刻下的第二接口数据，其中，所述当前时刻为获取所述第一接口数据的时刻；基于所述接口应用确定所述第二接口数据在所述上一时刻和所述当前时刻之间的变化数据；根据所述变化数据，更新所述第二接口数据，得到所述第一接口数据。3.根据权利要求2所述的方法，其特征在于，所述确定所述第二接口数据在所述上一时刻和所述当前时刻之间的变化数据，包括：根据扫描所述微服务应用的代码得到的所述代码的注释，确定所述第二接口数据在所述上一时刻和所述当前时刻之间的变化数据，并采用远程调用技术将所述变化数据发送至所述接口应用。4.根据权利要求2所述的方法，其特征在于，所述确定所述第二接口数据在所述上一时刻和所述当前时刻之间的变化数据，还包括：在所述当前时刻下，基于打包插件将所述微服务应用打包，得到第一打包文件，在所述上一时刻下，基于所述打包插件将所述微服务应用打包，得到第二打包文件，其中，所述第一打包文件包括所述第一接口数据，所述第二打包文件包括所述第二接口数据；将所述第一打包文件和所述第二打包文件保存在预先配置的本地路径指示的位置处；所述接口应用通过所述本地路径读取所述第一打包文件和所述第二打包文件，确定所述第二接口数据在所述上一时刻和所述当前时刻之间的变化数据。5.根据权利要求2所述的...

【专利技术属性】
技术研发人员：范威，
申请(专利权)人：中国工商银行股份有限公司，
类型：发明
国别省市：