[发明专利]基于网页的接口文档生成方法、装置、系统及计算机设备

说明书

本申请实施例属于接口调试技术领域，涉及基于网页的接口文档生成方法、装置、系统及计算机设备，方法包括：拦截网页客户端的接口调试请求；从所述接口调试请求中解析出待调试接口的信息，并将所述待调试接口的信息传递给后端框架；所述后端框架基于所述待调试接口的信息调用对应的控制器执行，生成所述待调试接口的文档并返回给所述网页客户端。拦截并解析网页客户端的接口调试请求信息，匹配后端框架的控制器即可在网页实时自动生成接口文档，同时，暴露接口的输入输出参数，通过模拟接口的参数数据可以方便接口的在线调试。

技术领域

本发明涉及接口调试技术领域，尤其涉及基于网页的接口文档生成方法、装置、系统及计算机设备。

背景技术

随着swagger(国外开源接口生成工具，以下简称“斯瓦格”工具)在spring(国外网页开发开源框架，以下简称“斯伯润”框架)圈子的流行，而JFinal(简称“杰凡尼”)一直没有类似的框架去管理接口，调试接口以及接口文档的实时生成，也无法把“斯伯润”框架的“斯瓦格”工具集成进入“杰凡尼”，因为框架实现原理不同，而造成“杰凡尼”框架的项目一直无法兼容的情况。而且传统的“斯瓦格”工具界面也非常丑，模块不好管理，文档不清晰且不能实时生成和显示，也不便快捷的在线调试接口。

发明内容

本申请实施例的目的在于提出一种基于网页的接口文档生成方法，实时获取接口文档以便进行可视化的接口在线调试。

为了解决上述技术问题，本申请实施例提供一种基于网页的接口文档生成方法，采用了如下所述的技术方案：

所述基于网页的接口文档生成方法包括以下步骤：

拦截网页客户端的接口调试请求；

从所述接口调试请求中解析出待调试接口的信息，并将所述待调试接口的信息传递给后端框架；

所述后端框架基于所述待调试接口的信息调用对应的控制器执行，生成所述待调试接口的文档并返回给所述网页客户端。

进一步的，所述控制器运行于所述后端框架中，所述后端框架通过自定义注解调用所述控制器。

进一步的，所述自定义注解包括参数和方法名，所述参数包括路由。

进一步的，所述后端框架基于待调试接口的信息匹配所述自定义注解，并基于匹配到的所述自定义注解的所述路由调用对应的控制器。

进一步的，所述控制器根据所述方法名和所述参数调用对应的方法执行，生成所述待调试接口的文档并以网页形式返回。

进一步的，所述后端框架包括JFinal。

为了解决上述技术问题，本申请实施例还提供一种基于网页的接口文档生成装置，包括:

拦截模块，用于拦截网页客户端的接口调试请求；

解析模块，用于从所述接口调试请求中解析出待调试接口的信息，并将所述待调试接口的信息传递给后端框架；

生成模块，用于所述后端框架基于所述待调试接口的信息调用对应的控制器执行，生成所述待调试接口的文档并返回给所述网页客户端。

为了解决上述技术问题，本申请实施例还提供一种基于网页的接口文档生成系统，所述基于网页的接口文档生成系统包括客户端和服务端，所述服务端包括拦截器和JFinal框架。所述客户端为网页客户端，用于发送接口文档生成请求并进行可视化接口调试；所述拦截器用于响应所述客户端的请求并和所述JFinal框架通信；所述JFinal框架用于生成并返回所述接口文档。

为了解决上述技术问题，本申请实施例还提供一种计算机设备，采用了如下所述的技术方案：