基于SpringMVC的API文档生成方法及系统

基本信息

申请号 CN201710800995.3 申请日 -
公开(公告)号 CN107515771A 公开(公告)日 2017-12-26
申请公布号 CN107515771A 申请公布日 2017-12-26
分类号 G06F9/45 分类 计算;推算;计数;
发明人 王思望 申请(专利权)人 蓝海天网科技有限公司
代理机构 福州科扬专利事务所 代理人 林朝熙
地址 350001 福建省福州市鼓楼区乌山西路318号洪山科技园创业中心大厦第3层
法律状态 -

摘要

摘要 基于SpringMVC的API文档生成方法及系统,通过自定义的注解,在自定义数据Bean中标记API信息,所述自定义Bean用于服务端代码的Controller层的函数的出参入参,遍历服务端运行的代码Controller层方法,自动抓取其函数的入参出参引用,解析出参入参的所有参数,生成API文档,通过所述参数对象的相互引用嵌套,自动构建起API的参数层级结构,然后将其遍历解析得到的结果下发到Web客户端,为前端开发人员提供可视化的API技术文档。本发明可解决API文档更新不及时,维护成本高等问题,节约开发人员时间成本,提高工作积极性。