发明名称 自动生成API接口的描述文档的方法和装置
摘要 本发明公开了一种自动生成API接口的描述文档的方法和装置,所述方法包括:对于与所述API接口具有映射关系的方法函数,生成该方法函数的反射对象;获取所述反射对象中包含的该方法函数的注解信息;根据获取的注解信息,按预定格式生成所述API接口的描述文档。由于利用反射机制生成方法函数的反射对象,并从反射对象中获取方法函数的注解信息,而注解信息中通常包括了该方法函数的功能的描述与参数的描述,因此,根据注解信息可自动生成预定格式的描述文档,从而实现自动生成涉及该方法函数的API接口的描述文档,节约人力成本,更便于描述文档与其API接口的更新的同步。
申请公布号 CN103049271A 申请公布日期 2013.04.17
申请号 CN201210581818.8 申请日期 2012.12.27
申请人 微梦创科网络科技(中国)有限公司 发明人 张威
分类号 G06F9/44(2006.01)I;G06F17/30(2006.01)I 主分类号 G06F9/44(2006.01)I
代理机构 北京市京大律师事务所 11321 代理人 黄启行;方晓明
主权项 一种自动生成API接口的描述文档的方法,包括:对于与所述API接口具有映射关系的方法函数,生成该方法函数的反射对象;获取所述反射对象中包含的该方法函数的注解信息;根据获取的注解信息,按预定格式生成所述API接口的描述文档。
地址 100080 北京市海淀区海淀北二街10号701室