[发明专利]一种Restful接口返回值自动化检查矫正方法

说明书

本发明提供一种Restful接口返回值自动化检查矫正方法，涉及互联网应用程序开发技术领域。该方法包括：针对注解有@RestController的接口定义类，建立同名XML文件；为每一个接口函数添加子元素；为子元素添加属性id；查询API接口定义文档，确认接口所需返回值Json的结构和字段，并对子元素按层级添加字段同名的下层子元素；为子元素添加属性type标识类型和属性init标识初始值；添加切面Aspect检查接口函数返回值，与XML文件元素的标准接口层级字段比对，矫正层级字段。利用Java自定义注解技术，实现了返回值Json的自动检查矫正，将接口字段检查矫正与业务逻辑分离，提高了开发效率。

技术领域

本发明涉及互联网应用程序开发技术领域，具体涉及一种Restful接口返回值自动化检查矫正方法。

背景技术

Restful是一种网络应用程序的设计风格和开发方式，Restful接口返回值目前主流的应该只有XML、Json两种格式。Restful适用于移动互联网厂商作为业务接口的场景。它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用，是目前流行的一种互联网软件架构。

对于Restful接口返回值Json，为了进行高效检查矫正，需要提供一种能够进行自动化检查矫正的方法。

发明内容

本发明的目的在于，提供一种Restful接口返回值自动化检查矫正方法，以解决Restful接口返回值Json自动化检查矫正问题。

为实现上述目的，本发明采用的技术方案如下：

本发明提供了一种Restful接口返回值自动化检查矫正方法，该方法基于Java，对Restful接口返回值Json进行自动化检查矫正，所述方法包括：

针对注解有@RestController的接口定义类，建立一个同名的XML格式文件，并添加根元素；

在XML格式文件中，为接口定义类的每一个接口函数对应添加一个子元素；

为每一个子元素添加属性id，属性id的值为对应的接口函数名；

查询API接口定义文档，确认每一个接口所需返回值Json的结构和字段，并且对于XML格式文件中的每一个子元素，按层级添加字段同名的子元素；

为每一个子元素根据需要添加属性type标识类型，并且为每一个子元素根据需要添加属性init标识初始值；

添加切面Aspect检查接口函数返回值，与XML格式文件对应子元素的标准接口层级、字段进行比对，矫正层级字段，使最终输出返回值Json与API接口定义字段一致。

可选地，所述针对注解有@RestController的接口定义类，建立一个同名的XML格式文件，并添加根元素，包括：

创建静态资源文件夹；

针对带有注解@RestController的每一个接口定义类，在静态资源文件夹里创建对应的XML格式文件，XML格式文件的命名与对应的接口定义类相同；

在XML格式文件中添加根元素。

可选地，根元素的名称与静态资源文件夹的根目录名称一致。

可选地，XML格式文件中的子元素与API接口定义文档中需要进行结构字段矫正的最初始键一致。

可选地，属性type标识类型为如下标识类型中的一者：string、long、int、integer、double、float、boolean、map、object、list。

可选地，属性type标识类型的默认值缺省为string类型。