[发明专利]API文档管理方法、装置、计算机设备及存储介质

说明书

本发明实施例公开了一种API文档管理方法、装置、计算机设备及存储介质。所述方法包括：若检测到目标接口文档创建完成，获取目标接口的目标地址，其中，所述目标接口是创建所述目标接口文档时定义的接口；根据所述目标地址创建对应所述目标接口文档的目标方法，以及创建对应所述目标接口文档中参数的目标类；根据所述目标类调用所述目标方法以生成所述目标接口文档对应的目标程序代码。本发明应用于开发辅助工具领域，通过实施本发明实施例的方法可实现API文档与程序代码的同步更新，提高了开发效率，节省系统资源。

技术领域

本发明涉及数据处理技术领域，尤其涉及一种API文档管理方法、装置、计算机设备及存储介质。

背景技术

API文档是软件开发与维护过程中的重要资料，但是API文档编写比较费时，而且在软件程序出现变更之后经常会出现API文档与软件程序不一致的情况。现有技术的这种API文档管理办法的缺点是，需要有人专门去维护API文档信息，因为API文档和其对应的代码是分开的。但是，在开发过程中，开发人员需要经常修改API的定义，这就必须要求API文档要同步更新，而开发人员经常忘记更新API文档，导致API文档描述不符合现有API的定义，API文档描述落后于当前API的实际功能。在Java开发中最常用的开发技术是Spring，而目前的API文档管理工具没能很好地与Spring结合实现API文档自动管理。

发明内容

本发明实施例提供了一种API文档管理方法、装置、计算机设备及存储介质，旨在解决API文档与程序代码不能保持一致的问题。

第一方面，本发明实施例提供了一种API文档管理方法，其包括：若检测到目标接口文档创建完成，获取目标接口的目标地址，其中，所述目标接口是创建所述目标接口文档时定义的接口；根据所述目标地址创建对应所述目标接口文档的目标方法，以及创建对应所述目标接口文档中参数的目标类；根据所述目标类调用所述目标方法以生成所述目标接口文档对应的目标程序代码。

第二方面，本发明实施例还提供了一种API文档管理装装置，其包括：获取单元，用于若检测到目标接口文档创建完成，获取目标接口的目标地址，其中，所述目标接口是创建所述目标接口文档时定义的接口；创建单元，用于根据所述目标地址创建对应所述目标接口文档的目标方法，以及创建对应所述目标接口文档中参数的目标类；生成单元，用于根据所述目标类调用所述目标方法以生成所述目标接口文档对应的目标程序代码。

第三方面，本发明实施例还提供了一种计算机设备，其包括存储器及处理器，所述存储器上存储有计算机程序，所述处理器执行所述计算机程序时实现上述方法。

第四方面，本发明实施例还提供了一种计算机可读存储介质，所述存储介质存储有计算机程序，所述计算机程序当被处理器执行时可实现上述方法。

本发明实施例提供了一种API文档管理方法、装置、计算机设备及存储介质。其中，所述方法包括：若检测到目标接口文档创建完成，获取目标接口的目标地址，其中，所述目标接口是创建所述目标接口文档时定义的接口；根据所述目标地址创建对应所述目标接口文档的目标方法，以及创建对应所述目标接口文档中参数的目标类；根据所述目标类调用所述目标方法以生成所述目标接口文档对应的目标程序代码。本发明实施例由于通过根据目标地址创建目标接口文档对应的目标方法和目标类，根据目标类调用目标方法生成目标接口文档对应的目标程序代码，可实现API文档与程序代码的同步更新，提高了开发效率，节省系统资源。

附图说明

为了更清楚地说明本发明实施例技术方案，下面将对实施例描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1为本发明实施例提供的API文档管理方法的流程示意图；

图2为本发明实施例提供的API文档管理方法的子流程示意图；