[发明专利]自动生成API接口的描述文档的方法和装置

权利要求书

1.一种自动生成API接口的描述文档的方法，包括：

对于与所述API接口具有映射关系的方法函数，生成该方法函数的反射对象；

获取所述反射对象中包含的该方法函数的注解信息；

根据获取的注解信息，按预定格式生成所述API接口的描述文档。

2.如权利要求1所述的方法，其中，所述注解信息遵循设定规范并由注解标识符标识出来，所述注解信息包括：内容属性标签，对应该内容属性标签的注解内容。

3.如权利要求2所述的方法，其中，所述内容属性标签包括：

API接口描述属性标签，对应该API接口描述属性标签的注解内容包括：API接口的功能描述；

参数描述属性标签，对应该参数描述属性标签的注解内容包括：API接口的参数描述；

请求方式属性标签，对应该请求方式属性标签的注解内容包括：API接口的请求方式的描述。

4.如权利要求3所述的方法，其中，所述根据获取的注解信息，按预定格式生成所述API接口的描述文档具体包括：

在所述描述文档中，根据对应API接口描述属性标签的注解内容以预定格式记录API接口的功能描述；根据对应参数描述属性标签的注解内容以预定格式记录API接口的参数描述；根据对应请求方式属性标签的注解内容以预定格式记录API接口的请求方式的描述。

5.如权利要求4所述的方法，其中，所述API接口为多个，以及与各API接口具有映射关系的方法函数在同一指定路径下，属于至少一个类；以及

所述内容属性标签还包括：路径属性标签；对应该路径属性标签的注解内容包括：路径信息；以及，对应所述API接口描述属性标签的注解内容还包括：接口分类信息以及接口序号信息。

6.如权利要求5所述的方法，其中，在所述按预定格式生成所述API接口的描述文档之前，还包括：

生成所述指定路径下的类的反射对象；

对于生成的方法函数和类的反射对象，从中选择出具有路径属性标签的反射对象；

针对每个选择出的反射对象，确定该反射对象中的注解信息中的接口分类信息以及接口序号信息；并根据确定出的接口分类信息以及接口序号信息对反射对象进行分类、排序后，以键-值形式存储到数据结构中；其中，所述键为接口分类信息，对应该键的值为具有该接口分类信息的反射对象；所述数据结构中，具有相同接口分类信息的反射对象依接口序号信息依次排列存储；

在HTML格式的目录文件中对应各方法函数分别生成一个目录条目，目录条目的顺序依据上述数据结构中各反射对象的存储顺序；所述目录条目中记录了与其对应的方法函数具有映射关系的API接口的功能简介，以及该API接口的描述文档的超链接。

7.如权利要求6所述的方法，其中，所述根据获取的注解信息，按预定格式生成所述API接口的描述文档还包括：

在所述API接口的描述文档中，根据第一注解信息中的对应该路径属性标签的注解内容和第二注解信息中的对应该路径属性标签的注解内容，以预定格式记录API接口的路径；其中，第一注解信息是从与该API接口具有映射关系的方法函数的反射对象中获取的，第二注解信息是从该方法函数所属的类的反射对象中获取的。

8.一种自动生成API接口的描述文档的装置，其特征在于包括：

反射对象生成模块，用于对于与所述API接口具有映射关系的方法函数，生成该方法函数的反射对象；

描述文档生成模块，用于获取所述反射对象生成模块生成的反射对象中包含的该方法函数的注解信息；根据获取的注解信息，按预定格式生成所述API接口的描述文档。

9.如权利要求8所述的装置，其特征在于，所述注解信息遵循设定规范并由注解标识符标识出来，所述注解信息包括：内容属性标签，对应该内容属性标签的注解内容；

其中，所述内容属性标签包括：

API接口描述属性标签，对应该API接口描述属性标签的注解内容包括：API接口的功能描述；

参数描述属性标签，对应该参数描述属性标签的注解内容包括：API接口的参数描述；

请求方式属性标签，对应该请求方式属性标签的注解内容包括：API接口的请求方式的描述。

10.如权利要求9所述的装置，其特征在于，所述API接口为多个，以及与各API接口具有映射关系的方法函数在同一指定路径下，属于至少一个类；以及

所述内容属性标签还包括：路径属性标签；对应该路径属性标签的注解内容包括：路径信息；以及，对应所述API接口描述属性标签的注解内容还包括：接口分类信息以及接口序号信息；以及

所述反射对象生成模块还用于生成所述指定路径下的类的反射对象；以及

所述装置还包括：

目录文件生成模块，用于对于所述反射对象生成模块生成的方法函数和类的反射对象，从中选择出具有路径属性标签的反射对象；针对每个选择出的反射对象，确定该反射对象中的注解信息中的接口分类信息以及接口序号信息；并根据确定出的接口分类信息以及接口序号信息对反射对象进行分类、排序后，以键-值形式存储到数据结构中；其中，所述键为接口分类信息，对应该键的值为具有该接口分类信息的反射对象；所述数据结构中，具有相同接口分类信息的反射对象依接口序号信息依次排列存储；在HTML格式的目录文件中对应各方法函数分别生成一个目录条目，目录条目的顺序依据上述数据结构中各反射对象的存储顺序；所述目录条目中记录了与其对应的方法函数具有映射关系的API接口的功能简介，以及该API接口的描述文档的超链接。