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

权利要求书

1.一种API文档管理方法，其特征在于，包括：

若检测到目标接口文档创建完成，获取目标接口的目标地址，其中，所述目标接口是创建所述目标接口文档时定义的接口；

根据所述目标地址创建对应所述目标接口文档的目标方法，以及创建对应所述目标接口文档中参数的目标类；

根据所述目标类调用所述目标方法以生成所述目标接口文档对应的目标程序代码。

2.根据权利要求1所述的API文档管理方法，其特征在于，所述根据所述目标地址创建对应所述目标接口文档的目标方法，以及创建对应所述目标接口文档中参数的目标类，包括：

在控制目录下根据所述目标地址创建控制类，并在所述控制类中创建对应所述目标接口文档的目标方法；

在控制目录的父目录下创建第一目标类目录，并在所述第一目标类目录下根据所述目标地址创建对应所述目标接口文档中入参字段的入参类；

在控制目录的父目录下创建第二目标类目录，并在所述第二目标类目录下根据所述目标地址创建对应所述目标接口文档中出参字段的出参类。

3.根据权利要求2所述的API文档管理方法，其特征在于，所述根据所述目标类调用所述目标方法以生成所述目标接口文档对应的目标程序代码之前，还包括：

判断所述目标方法的类型；

若所述目标方法的类型为获取型方法，则对所述目标方法添加第一注解；

若所述目标方法的类型为提交型方法，则对所述目标方法添加第二注解。

4.根据权利要求2-3任一项所述的API文档管理方法，其特征在于，所述方法还包括：

若所述控制目录或者所述第一目标类目录或者所述第二目标类目录下的文件存在更新，根据所述控制类与所述目标方法之间的类引用关系获取所述目标方法；

获取所述目标方法对应的目标地址，并根据所述目标地址查找所述目标接口文档；

根据所述控制目录或者所述第一目标类目录或者所述第二目标类目录下的文件更新所述目标接口文档中的接口内容。

5.根据权利要求4所述的API文档管理方法，其特征在于，所述根据所述控制目录或者所述第一目标类目录或者所述第二目标类目录下的文件更新所述目标接口文档中的接口内容，包括：

识别更新的文件所存在的目录；

根据更新的文件所存在的目录确定需要更新的接口内容，其中，所述更新的接口内容包括所述入参类、所述出参类以及所述目标地址；

将所确定更新的接口内容更新到所述目标接口文档的接口内容中。

6.一种API文档管理装置，其特征在于，包括：

获取单元，用于若检测到目标接口文档创建完成，获取目标接口的目标地址，其中，所述目标接口是创建所述目标接口文档时定义的接口；

创建单元，用于根据所述目标地址创建对应所述目标接口文档的目标方法，以及创建对应所述目标接口文档中参数的目标类；

生成单元，用于根据所述目标类调用所述目标方法以生成所述目标接口文档对应的目标程序代码。

7.根据权利要求6所述的API文档管理装置，其特征在于，所述创建单元包括：

第一创建单元，用于在控制目录下根据所述目标地址创建控制类，并在所述控制类中创建对应所述目标接口文档的目标方法；

第二创建单元，用于在控制目录的父目录下创建第一目标类目录，并在所述第一目标类目录下根据所述目标地址创建对应所述目标接口文档中入参字段的入参类；

第三创建单元，用于在控制目录的父目录下创建第二目标类目录，并在所述第二目标类目录下根据所述目标地址创建对应所述目标接口文档中出参字段的出参类。