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

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

API document generation method and system based on SpringMVC

API system and document generation method based on SpringMVC, through a custom annotation, tag API information in the custom data Bean, the custom Bean function for the Controller layer server code the incorporation of ginseng, Controller code layer traversing the server running, automatically crawl the function into a reference reference reference, analysis in all parameters, generating API documents, through the mutual reference parameters of the nested object, construct the hierarchical structure of the API parameters automatically, then obtain the ergodic analytic result is sent to the Web client, provide API technical documentation for visual front-end developers. The invention can solve the problems of API document updating in time and high maintenance cost, save the time cost of the developer and improve the enthusiasm of the work.

【技术实现步骤摘要】
基于SpringMVC的API文档生成方法及系统
本专利技术涉及应用程序开发，具体涉及基于SpringMVC的API文档生成方法及系统。
技术介绍
当前互联网中有大量的WebApp开发都是使用到了JavaEE技术，并且大量地使用SpringMVC后端框架。开发中，API文档是前后端对接接口、调试接口的必不可少的技术文档。当然API文档是独立于运行的代码之外，可以采取人工编写的方式，也可以选择网络上提供的一系列API文档生成框架生成。无论采取哪种方式，API文档的准确性、及时性极大地影响着前后端开发人员的开发效率和开发热情，所以一个高度自动化的API文档框架有着重要的意义和作用。API接口文档如果采用Word、Excel等脱离代码的纯文本API文档，容易出现API文档版本众多，维护和发布困难，前后端代码时效性低等问题，并且极易出现人工书写错误，可靠性低。对比现有的Apidoc的框架可以发现，其API文档描述没有脱离代码，采用Web的形式，这极大地提高API的时效性。但其API文档生成全部依赖于手写的Java注解，使得API中的关键信息（如入参出参变量名称）容易出现人工编写的错误，并且为本文档来自技高网...

【技术保护点】
基于SpringMVC的API文档生成方法，其特征在于：通过自定义的注解，在自定义数据Bean中标记API信息，所述自定义Bean用于服务端代码Controller函数的出参入参；遍历服务端运行的代码Controller层方法，自动抓取其函数的入参出参引用；解析出参入参的所有参数，生成API文档，通过所述参数对象的相互引用嵌套，自动构建起API的参数层级结构；将其遍历解析得到的结果下发到Web客户端，为开发人员提供可视化的API技术文档。

【技术特征摘要】
1.基于SpringMVC的API文档生成方法，其特征在于：通过自定义的注解，在自定义数据Bean中标记API信息，所述自定义Bean用于服务端代码Controller函数的出参入参；遍历服务端运行的代码Controller层方法，自动抓取其函数的入参出参引用；解析出参入参的所有参数，生成API文档，通过所述参数对象的相互引用嵌套，自动构建起API的参数层级结构；将其遍历解析得到的结果下发到Web客户端，为开发人员提供可视化的API技术文档。2.如权利要求1所述的API文档自动生成方法，其中所述自定义注解为原生的Java注解。3.如权利要求1所述的API文档自动生成方法，其中所述自定义注解由@Doc、@Act，@DataLength，@DataRange四个注解组成，用于描述API字段的属性。4.如权利要求1所述的API文档自动生成方法，其中所述客户端展示Html页面，用于展示从服务端请求下来的API文档数据。5.如权利要求1所述的API文档自动生成方法，其中在服务端由Script脚本构建Html代码，来实现向用户提供可视化API技术文档。6.基于SpringMVC的API文档生成系统，该系统主要包括自动API文档生成框架部分和常规业务代码部分，其特征在于：所述自动API文档生成框架...

【专利技术属性】
技术研发人员：王思望，
申请(专利权)人：蓝海天网科技有限公司，
类型：发明
国别省市：福建,35