[发明专利]一种生成接口文档的方法及装置

权利要求书

1.一种生成接口文档的方法，其特征在于，所述方法包括：

获取用户待查看接口对应的代码文件；

在所述代码文件中获取接口注释代码，其中所述接口注释代码中保存有所述待查看接口的接口属性信息以及该接口属性信息对应的接口属性参数；

根据所述接口注释代码，生成所述待查看接口对应的接口文档。

2.根据权利要求1所述的方法，其特征在于，所述获取用户待查看接口对应的代码文件，包括：

接收用户在接口配置文件中选取的待查看接口的接口标识；

在预先存储的接口标识与代码文件的路径信息的对应关系中，选取所述接口标识对应的代码文件的路径信息；

根据所述代码文件的路径信息，获取所述待查看接口对应的代码文件。

3.根据权利要求1所述的方法，其特征在于，所述在所述代码文件中获取接口注释代码，包括：

在所述代码文件的代码头中，查询注释代码标签；

将所述注释代码标签中的代码段确定为接口注释代码。

4.根据权利要求1所述的方法，其特征在于，所述根据所述接口注释代码，生成所述待查看接口对应的接口文档，包括：

在所述接口注释代码中，获取预设的接口属性信息对应的接口属性参数；

将所述预设的接口属性信息对应的接口属性参数，添加入预先存储的接口文档模版中包含的与所述预设的接口属性信息相匹配的参数位置；

将添加了接口属性参数的接口文档模版确定为所述待查看接口对应的接口文档。

5.根据权利要求1或4所述的方法，其特征在于，所述根据所述接口注释代码，生成所述待查看接口对应的接口文档之后，所述方法还包括：

获取所述待查看接口对应的测试用例代码，并将所述测试用例代码添加入所述待查看接口对应的接口文档中，其中所述测试用例代码用于对所述待查看接口进行测试使用。

6.一种生成接口文档的装置，其特征在于，所述装置包括：

第一获取模块，用于获取用户待查看接口对应的代码文件；

第二获取模块，用于在所述代码文件中获取接口注释代码，其中所述接口注释代码中保存有所述待查看接口的接口属性信息以及该接口属性信息对应的接口属性参数；

生成模块，用于根据所述接口注释代码，生成所述待查看接口对应的接口文档。

7.根据权利要求6所述的装置，其特征在于，所述第一获取模块，包括：

接收单元，用于接收用户在接口配置文件中选取的待查看接口的接口标识；

选取单元，用于在预先存储的接口标识与代码文件的路径信息的对应关系中，选取所述接口标识对应的代码文件的路径信息；

第一获取单元，用于根据所述代码文件的路径信息，获取所述待查看接口对应的代码文件。

8.根据权利要求6所述的装置，其特征在于，所述第二获取模块，包括：

查询单元，用于在所述代码文件的代码头中，查询注释代码标签；

第一确定单元，用于将所述注释代码标签中的代码段确定为接口注释代码。

9.根据权利要求6所述的装置，其特征在于，所述生成模块，包括：

第二获取单元，用于在所述接口注释代码，获取预设的接口属性信息对应的接口属性参数；

添加单元，用于将所述预设的接口属性信息对应的接口属性参数，添加入预先存储的接口文档模版中包含的与所述预设的接口属性信息相匹配的参数位置；

第二确定单元，用于将添加了接口属性参数的接口文档模版确定为所述待查看接口对应的接口文档。

10.根据权利要求6或9所述的装置，其特征在于，所述装置还包括：

添加模块，用于获取所述待查看接口对应的测试用例代码，并将所述测试用例代码添加入所述待查看接口对应的接口文档中，其中所述测试用例代码用于根据对所述待查看接口进行测试使用。