[发明专利]应用程序接口文档的生成方法、装置、计算机设备及介质

说明书

本发明公开了一种应用程序接口文档的生成方法、装置、计算机设备和存储介质，该方法包括：对微服务的工程文件集进行扫描，获取工程文件集中包括的结构体，并将结构体中包括的各属性信息存储于对应的结构体数组中；在工程文件集合中，获取用于存储接口定义函数的至少一个接口定义文件；对各接口定义文件进行解析，并将与各接口定义函数分别对应的关键接口信息存储于对应的接口结构体中；对各接口结构体以及各所述结构体数组进行对应解析，生成与微服务匹配的接口文档。本发明实施例的技术方案提供了一种自动化生成接口文档的新方式，在提高接口文档的生成效率的同时，避免了人为生成接口文档时可能造成的各种错误，提高了接口文档的准确性。

技术领域

本发明实施例涉及数据处理技术，尤其涉及一种应用程序接口文档的生成方法、装置、计算机设备及介质。

背景技术

在软件项目的开发过程中，免不了需要前端的客户端和后端的服务端进行对接，前端的客户端和后端的服务端一般由不同的开发人员开发，因此服务端需要通过开发人员定义的API(Application Programming Interface，即应用程序接口)对外提供服务，客户端则需要根据API提供的功能进行对接开发，因此用于描述服务端API功能的API文档(也可以称为接口文档)必不可少。

发明人在实现本发明的过程中，发现：当前的API文档需要开发人员根据API的结构进行手工编写，花费了开发人员大量的时间，而且容易定义出错；同时，当发生接口定义修改的时候，容易发生API文档中的接口描述和实际情况不符合，影响前后端的协作。

发明内容

本发明实施例提供了一种应用程序接口文档的生成方法、装置、计算机设备及存储介质，实现了自动化生成API文档的新方式，提高了API文档的生成效率和准确性。

第一方面，本发明实施例提供了一种应用程序接口文档的生成方法，所述方法包括：

对微服务的工程文件集进行扫描，获取所述工程文件集中包括的各结构体，并将每个结构体中包括的各属性信息存储于对应的结构体数组中；

在所述工程文件集合中，获取用于存储接口定义函数的至少一个接口定义文件；

对各所述接口定义文件进行解析，并将与各所述接口定义函数分别对应的关键接口信息存储于对应的接口结构体中；

对各所述接口结构体以及各所述结构体数组进行对应解析，生成与所述微服务匹配的接口文档。

第二方面，本发明实施例还提供了一种应用程序接口文档的生成装置，该装置包括：

结构体数组生成模块，用于对微服务的工程文件集进行扫描，获取所述工程文件集中包括的各结构体，并将每个结构体中包括的各属性信息存储于对应的结构体数组中；

接口定义文件获取模块，用于在所述工程文件集合中，获取用于存储接口定义函数的至少一个接口定义文件；

接口结构体生成模块，用于对各所述接口定义文件进行解析，并将与各所述接口定义函数分别对应的关键接口信息存储于对应的接口结构体中；

接口文档生成模块，用于对各所述接口结构体以及各所述结构体数组进行对应解析，生成与所述微服务匹配的接口文档。

第三方面，本发明实施例还提供了一种计算机设备，所述计算机设备包括：

一个或多个处理器；

存储装置，用于存储一个或多个程序；

当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现如本发明任意实施例所述的应用程序接口文档的生成方法。

第四方面，本发明实施例还提供了一种计算机存储介质，其上存储有计算机程序，该程序被处理器执行时实现如本发明任意实施例所述的应用程序接口文档的生成方法。