[发明专利]一种微服务的接口信息展示方法、装置及电子设备

说明书

本发明实施例提供了一种微服务的接口信息展示方法、装置及电子设备，包括：收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息，并且针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息，以及在预设的界面中，展示解析出的各微服务的接口信息，并从所展示的各微服务的接口信息中，查找并展示所需的接口信息，由于集中收集了各微服务的接口文档，并且在同一个界面中就可以查看各微服务的接口信息，使得各微服务的接口信息方便管理。

技术领域

本发明涉及互联网项目开发技术领域，特别是涉及一种微服务的接口信息展示方法、装置及电子设备。

背景技术

互联网项目开发过程中，为了确保前端工程和后端工程能够进行正常的数据交换，往往需要进行前后端联调，通常在前后端联调的过程中，后端工程人员需要向前端项目工程人员提供后端工程的接口文档，其中，接口文档中记录有后端工程提供的各个接口的接口信息，例如URL(Uniform Resource Locator，统一资源定位符)、请求参数和返回参数等信息。

wiki(维客)是一种可供多人协同创作的超文本系统，现有技术中，后端工程人员通常通过wiki向前端工程人员提供后端工程的接口文档，后端工程人员在wiki中需要手动输入后端工程的各接口的接口信息来创建接口文档，前端工程人员根据后端工程人员在wiki中创建的接口文档，确定后端工程各接口的接口信息。

通过wiki创建接口文档需要手写编辑，当后端工程的某接口的接口信息更改了后，后端工程人员需要在wiki中实时更新接口文档，非常不方便，为了解决这一问题，现有技术中，还存在通过在前端工程和后端工程中集成开源软框架的方式，实现自动将后端工程的各接口的接口信息展示给前端开发人员，其中，开源软件框架可以是名称为Swagger的开源软件框架。后端工程人员在进行项目开发过程中，通过对后端工程中的各接口添加注解，使Swagger框架自动生成包含有接口信息的接口文档，当前端工程人员需要查看后端工程的接口信息时，通过在Swagger-UI(Swagger-User Interface，Swagger-用户界面)中输入后端工程的地址，即可方便在Swagger-UI提供的页面中查看该后端工程的接口文档中包含的后端工程各接口的接口信息。

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

为了提高前端工程和后端工程的可维护性，互联网项目的开发越来越倾向于采用微服务化，即将一个完整的工程项目拆分为多个微服务工程项目，分别进行开发，例如，在开发一个网页后端项目时，可以将网页后端项目拆分为用户登录服务、视频播放服务、用户信息获取服务、会员开通服务等多个微服务项目，采用现有技术的Swagger框架，各个微服务可能具有不同的工程地址，从而使得开发人员不能很好的管理各微服务的接口信息。

发明内容

本发明实施例的目的在于提供一种微服务的接口信息展示方法，以方便的管理各微服务的接口信息。具体技术方案如下：

本发明实施例提供一种微服务的接口信息展示方法，包括：

收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息；

针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息；

在预设的界面中，展示解析出的各微服务的接口信息，并从所展示的各微服务的接口信息中，查找并展示所需的接口信息。

进一步的，所述收集各微服务的接口文档，包括：

获取各微服务的工程地址和接口文档生成地址，其中，针对每一个微服务，该微服务的工程地址包括运行该微服务的设备的IP地址，该微服务的接口文档生成地址为该设备中存储该微服务自动生成的接口文档的存储地址；