【技术实现步骤摘要】
本专利技术涉及计算机技术，尤其涉及自动生成API接口的描述文档的方法和装置。
技术介绍
当今众多的社交网站都提供一种开放的API (Application Program Interface, 应用程序接口)接口供第三方客户端或网站调用，达到信息快速分享、增加用户粘度、开辟 新的盈利模式的目的。这些网站提供的API接口中不乏采用REST(Representational State Transfer,表述性状态转换)架构提供的WEB (网络)服务解决方案。由于REST风格的WEB 服务建立在HTTP(Hyper Text Transport Protocol,超文本传输协议)协议之上,相比SOAP (Simple Object Access Protocol,简单对象访问协议)以及XML-RPC等方案具有轻量、简 单、优雅、高效等特点，因而被众多社交网站的开放平台所青睐。例如，新浪微博的开放平台 目前就是建立在REST风格的WEB服务架构之上，对外开放了一组功能完善的API接口。通 过这些REST风格的API接口，第三方开发商可以开发出和社交网站数据紧密整合的各...
【技术保护点】
一种自动生成API接口的描述文档的方法，包括：对于与所述API接口具有映射关系的方法函数，生成该方法函数的反射对象；获取所述反射对象中包含的该方法函数的注解信息；根据获取的注解信息，按预定格式生成所述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所述的方法，其中，所述根据获取的注解信...
【专利技术属性】
技术研发人员：张威，
申请(专利权)人：微梦创科网络科技中国有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。