[发明专利]一种接口文档生成方法和装置

说明书

本发明公开了一种接口文档生成方法和装置，涉及计算机技术领域。该方法的一具体实施方式包括：接收资源定位请求，调用网关节点中的接口文档刷新服务，对各节点的接口信息进行聚合，得到与资源定位请求对应的路由服务列表；通过路由服务列表中的路由信息，进行代码文档信息获取；响应于对其中一个接口文档链接的点击操作，调用应用服务节点中的接口文档生成服务，获取与接口文档链接对应的接口文档并反馈。该实施方式可将注册中心中存储于路由信息表中的所有微服务接口文档服务统一、聚合在一个独立的页面中展示，大大提高了接口自动文档的生成查阅效率。

技术领域

本发明涉及计算机技术领域，尤其涉及一种接口文档生成方法和装置。

背景技术

项目开发过程通常采用前后端分别开发的方式。通常做法是预先设计一份接口文档，开发人员按照该接口文档进行前后端开发。且在项目结束前需要对接口文档进行更新，以便开发人员查看并了解最新的接口定义。

目前对于接口文档的自动化生成方式，主要有：

1)基于与接口文档生成指令对应的代码生成语法树，文本分析实现和构建创新性框架和局部细节，将接口文档以word或者excel等格式进行存储；

2)通过细化开源Swagger组件，引入统一web应用开发中关于API(ApplicationProgramming Interface，应用程序接口)定义的规范，并以此作为桥梁，提升web应用前后端定义与对接API的效率。

在实现本发明的过程中，发明人发现现有技术至少存在如下问题：

方式1不支持网络和web形式的生成和展示，方式2虽可以通过浏览器查阅web阅读文档，但与方式1都局限于单台计算机节点的接口文档生成处理。

发明内容

有鉴于此，本发明实施例提供一种接口文档生成方法和装置，至少能够解决现有技术中仅局限于单台计算机节点的接口文档生成处理。

为实现上述目的，根据本发明实施例的一个方面，提供了一种接口文档生成方法，包括：

接收资源定位请求，调用网关节点中的接口文档刷新服务，对各节点的接口信息进行聚合，得到与所述资源定位请求对应的路由服务列表；

通过所述路由服务列表中的路由信息，进行代码文档信息获取；其中，所述代码文档信息包括接口文档链接；

响应于对其中一个接口文档链接的点击操作，调用应用服务节点中的接口文档生成服务，获取与所述接口文档链接对应的接口文档并反馈。

可选的，在所述接收资源定位请求之前，还包括：

响应于对所述应用服务节点和所述网关节点的启动，判断预定表中预定字段的值是否为预定值，若是，则确定本次启动为首次启动；

调用所述网关节点中的参数配置服务，提取参数配置界面并发送至所述客户端进行显示，之后接收对所述参数配置界面中的参数输入，得到对所述网关节点的参数配置。

可选的，在所述判断预定表中预定字段的值是否为预定值之前，还包括：

将所述应用服务节点和所述网关节点在服务注册和发现节点中进行注册，以将所述应用服务节点的微服务信息和所述网关节点的微服务信息存储在所述服务注册和发现节点中。

可选的，在所述调用网关节点中的接口文档刷新服务之前，还包括：

调用所述网关节点中的安全访问服务，获取所述资源定位请求中的用户身份信息、IP地址和运行软件版本；

若所述用户身份信息中包含令牌信息，则确定所述资源定位请求的请求头包含令牌信息，对所述资源定位请求进行拦截；和/或