基于Javadoc的自动生成后端接口文档的方法及装置制造方法及图纸

本发明专利技术的基于Javadoc的自动生成后端接口文档的方法，具体包括以下步骤，在接口文件中定义接口信息；采用Javadoc对接口信息进行描述，描述代码的注释和接口；采用AST解析代码自动识别，识别出接口的输入参数、返回值类型、URL和异常数据；根据接口的定义和标准的Javadoc来全自动化生成接口文档。通过AST解析代码技术，根据Javadoc结合接口定义，实现所有代码改动后能够全自动化生成后端接口文档，还能根据接口数据生成前端代码，解决了过去代码和手工编写接口文档不同步的问题，不仅省去了编写接口文档的时间，还能避免接口文档和代码不同步的问题带来的返工情况，提高业务系统开发效率。

A method and device for automatic generation of back end interface documents based on Javadoc

The invention of the method of Javadoc automatic generation backend interface based on the document, including the following steps, define the interface information in the interface file; the interface information described in Javadoc, and describe the annotation interface code; using AST parsing code automatic identification, identify the input parameters and return type, URL interface and abnormal data according to the definition and standard interface; Javadoc automatic document generation interface. By parsing the AST code technology, according to the Javadoc binding interface definition, all code changes can be fully automated generation backend interface documentation, but also according to the interface data generation front-end code, solve the past code and manual writing interface document synchronization problem, not only eliminates the need to write the interface document time, can avoid rework brought interface documentation and code synchronization problems, improve the development efficiency of business system.

【技术实现步骤摘要】
基于Javadoc的自动生成后端接口文档的方法及装置
本专利技术涉及信息
，具体涉及一种自动生成后端接口文档的方法及装置。
技术介绍
传统方式下服务接口文档是由人工手动编写，按照接口定义，人工提取接口信息，人工梳理数据关系，然后根据接口定义信息，一个一个字段提取出来写在文档上面。每个字段都需要在文档中注明字段名称、字段类型、字段是否可以为空、字段的默认值、字段的示例值、字段的描述等。另外字段有基本数据类型和复杂结构体之分，复杂结构体可能有多层嵌套，深度可能多达数层。接口文档还需要包含每个接口的错误码。当接口数量较多时，这种纯机械式手工服务文档编写效率低下且容易出错，准确性无法保证。另外，Swagger的开源程序根据Javadoc注释来生成接口文档，但是需要额外增加Javadoc标记。
技术实现思路
针对现有技术中的缺陷，本专利技术的目的之一在于提供基于Javadoc的自动生成后端接口文档的方法，所有代码改动后能够全自动化生成接口文档，解决了过去代码和手工编写接口文档不同步的问题，提高业务系统开发效率。第一方面，本专利技术提供的基于Javadoc的自动生成后端接口文档的方法，具体包括本文档来自技高网...

【技术保护点】
一种基于Javadoc的自动生成后端接口文档的方法，其特征在于：具体包括以下步骤，在接口文件中定义接口信息；采用Javadoc对接口信息进行描述，描述代码的注释和接口；采用AST解析代码自动识别，识别出接口的输入参数、返回值类型、URL和异常数据；根据接口的定义和标准的Javadoc来全自动化生成接口文档。

【技术特征摘要】
1.一种基于Javadoc的自动生成后端接口文档的方法，其特征在于：具体包括以下步骤，在接口文件中定义接口信息；采用Javadoc对接口信息进行描述，描述代码的注释和接口；采用AST解析代码自动识别，识别出接口的输入参数、返回值类型、URL和异常数据；根据接口的定义和标准的Javadoc来全自动化生成接口文档。2.如权利要求1所述的基于Javadoc的自动生成后端接口文档的方法，其特征在于：所述采用Javadoc对接口信息进行描述，描述代码的注释和接口具体包括以下步骤：约定Javadoc中的第一行为注释名称，描述接口的名称；约定Javadoc中的大于等于第二行为接口信息描述；约定在POJO类的Javadoc前加上@mutable标记，表明当前的POJO是一个多态的POJO，所述多态的POJO有多个子类。3.如权利要求2所述的基于Javadoc的自动生成后端接口文档的方法，其特征在于：所述识别出输入参数的方法具体包括以下步骤：约定接口的参数中含有登录用户参数，根据登录用户参数判断是否需要进行登录验证；约定分页参数；对接口的输入参数解析，自动解析参数名称、参数类型和注释名称生成接口文档中的输入参数说明。4.如权利要求3所述的基于Javadoc的自动生成后端接口文档的方法，其特征在于：所述识别接口的URL的方法包括识别出Controller类的RequestMapping中的值作为URL中的目录，用Controller类函数的RequestMapping的值作为文件名；如果RequestMapping没有值，自动使用Controller类函数名称作为文件名。5.如权利要求4所述的基于Javadoc的自动生成后端接口文档的方法，其特征在于：所述识别出异常数据的方法采用根据接口的异常定义自动解析异常的类名为接口的错误码，并将异常的message或异常的注释名称作为错误消息。6.如权利要求2所述的基于Javadoc的自动生成后端接口文档的方法，其特征在于：所述多态的POJO包含一个类别属性，每个子类的类别属性值不同，属性值解析后输出到接口文档，子类的注释名称为子类...

【专利技术属性】
技术研发人员：谭海潮，
申请(专利权)人：珠海牛角科技有限公司，
类型：发明
国别省市：广东,44