CN110321154B - 一种微服务的接口信息展示方法、装置及电子设备 - Google Patents

一种微服务的接口信息展示方法、装置及电子设备 Download PDF

Info

Publication number
CN110321154B
CN110321154B CN201910555524.XA CN201910555524A CN110321154B CN 110321154 B CN110321154 B CN 110321154B CN 201910555524 A CN201910555524 A CN 201910555524A CN 110321154 B CN110321154 B CN 110321154B
Authority
CN
China
Prior art keywords
interface
micro
service
micro service
address
Prior art date
Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
Active
Application number
CN201910555524.XA
Other languages
English (en)
Other versions
CN110321154A (zh
Inventor
柯登科
周正
王杨
张大虎
段光磊
王平
徐婷
赫振军
Current Assignee (The listed assignees may be inaccurate. Google has not performed a legal analysis and makes no representation or warranty as to the accuracy of the list.)
Beijing QIYI Century Science and Technology Co Ltd
Original Assignee
Beijing QIYI Century Science and Technology Co Ltd
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by Beijing QIYI Century Science and Technology Co Ltd filed Critical Beijing QIYI Century Science and Technology Co Ltd
Priority to CN201910555524.XA priority Critical patent/CN110321154B/zh
Publication of CN110321154A publication Critical patent/CN110321154A/zh
Application granted granted Critical
Publication of CN110321154B publication Critical patent/CN110321154B/zh
Active legal-status Critical Current
Anticipated expiration legal-status Critical

Links

Images

Classifications

    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F16/00—Information retrieval; Database structures therefor; File system structures therefor
    • G06F16/30—Information retrieval; Database structures therefor; File system structures therefor of unstructured textual data
    • G06F16/33—Querying
    • G06F16/332—Query formulation
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F16/00—Information retrieval; Database structures therefor; File system structures therefor
    • G06F16/30—Information retrieval; Database structures therefor; File system structures therefor of unstructured textual data
    • G06F16/33—Querying
    • G06F16/338—Presentation of query results
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F8/00—Arrangements for software engineering
    • G06F8/70—Software maintenance or management
    • G06F8/71—Version control; Configuration management
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F8/00—Arrangements for software engineering
    • G06F8/70—Software maintenance or management
    • G06F8/73—Program documentation

Landscapes

  • Engineering & Computer Science (AREA)
  • Theoretical Computer Science (AREA)
  • General Engineering & Computer Science (AREA)
  • Physics & Mathematics (AREA)
  • Software Systems (AREA)
  • General Physics & Mathematics (AREA)
  • Computational Linguistics (AREA)
  • Databases & Information Systems (AREA)
  • Data Mining & Analysis (AREA)
  • Computer Security & Cryptography (AREA)
  • Mathematical Physics (AREA)
  • Library & Information Science (AREA)
  • Information Transfer Between Computers (AREA)
  • User Interface Of Digital Computer (AREA)

Abstract

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

Description

一种微服务的接口信息展示方法、装置及电子设备
技术领域
本发明涉及互联网项目开发技术领域，特别是涉及一种微服务的接口信息展示方法、装置及电子设备。
背景技术
互联网项目开发过程中，为了确保前端工程和后端工程能够进行正常的数据交换，往往需要进行前后端联调，通常在前后端联调的过程中，后端工程人员需要向前端项目工程人员提供后端工程的接口文档，其中，接口文档中记录有后端工程提供的各个接口的接口信息，例如URL(Uniform Resource Locator，统一资源定位符)、请求参数和返回参数等信息。
wiki(维客)是一种可供多人协同创作的超文本系统，现有技术中，后端工程人员通常通过wiki向前端工程人员提供后端工程的接口文档，后端工程人员在wiki中需要手动输入后端工程的各接口的接口信息来创建接口文档，前端工程人员根据后端工程人员在wiki中创建的接口文档，确定后端工程各接口的接口信息。
通过wiki创建接口文档需要手写编辑，当后端工程的某接口的接口信息更改了后，后端工程人员需要在wiki中实时更新接口文档，非常不方便，为了解决这一问题，现有技术中，还存在通过在前端工程和后端工程中集成开源软框架的方式，实现自动将后端工程的各接口的接口信息展示给前端开发人员，其中，开源软件框架可以是名称为Swagger的开源软件框架。后端工程人员在进行项目开发过程中，通过对后端工程中的各接口添加注解，使Swagger框架自动生成包含有接口信息的接口文档，当前端工程人员需要查看后端工程的接口信息时，通过在Swagger-UI(Swagger-User Interface，Swagger-用户界面)中输入后端工程的地址，即可方便在Swagger-UI提供的页面中查看该后端工程的接口文档中包含的后端工程各接口的接口信息。
发明人在实现本发明的过程中发现，现有技术至少存在如下问题：
为了提高前端工程和后端工程的可维护性，互联网项目的开发越来越倾向于采用微服务化，即将一个完整的工程项目拆分为多个微服务工程项目，分别进行开发，例如，在开发一个网页后端项目时，可以将网页后端项目拆分为用户登录服务、视频播放服务、用户信息获取服务、会员开通服务等多个微服务项目，采用现有技术的Swagger框架，各个微服务可能具有不同的工程地址，从而使得开发人员不能很好的管理各微服务的接口信息。
发明内容
本发明实施例的目的在于提供一种微服务的接口信息展示方法，以方便的管理各微服务的接口信息。具体技术方案如下：
本发明实施例提供一种微服务的接口信息展示方法，包括：
收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息；
针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息；
在预设的界面中，展示解析出的各微服务的接口信息，并从所展示的各微服务的接口信息中，查找并展示所需的接口信息。
进一步的，所述收集各微服务的接口文档，包括：
获取各微服务的工程地址和接口文档生成地址，其中，针对每一个微服务，该微服务的工程地址包括运行该微服务的设备的IP地址，该微服务的接口文档生成地址为该设备中存储该微服务自动生成的接口文档的存储地址；
针对每一个微服务，按照该微服务的工程地址和接口文档生成地址，收集该微服务的接口文档。
进一步的，所述获取各微服务的工程地址和接口文档生成地址，包括：
读取配置文件，获取所述配置文件中记录的各微服务的工程地址；
针对获取的每一个工程地址，确定预先与该工程地址建立有关联关系的接口文档生成地址。
进一步的，所述针对每一个微服务，按照该微服务的工程地址和接口文档生成地址，收集该微服务的接口文档，包括：
针对每一个微服务，根据该微服务的工程地址访问该微服务所在的设备；
按照该微服务的接口文档生成地址，从该设备中加载出该接口文档生成地址对应存储地址处的该微服务的接口文档。
进一步的，在所述展示解析出的各微服务的接口信息之前，该方法还包括：
接收展示选择操作，所述展示选择操作用于选择需要进行接口信息展示的微服务；
其中，所述在预设的界面中，展示解析出的各微服务的接口信息，包括：
根据所述展示选择操作，从解析出的各微服务的接口信息中，查找出所述展示选择操作所选择的微服务的接口信息，作为目标接口信息；
在预设的界面中，展示所述目标接口信息。
本发明实施例还提供一种微服务的接口信息展示装置，所述装置包括：
接口文档收集模块，用于收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息；
接口信息解析模块，用于针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息；
接口信息展示模块，用于在预设的界面中，展示解析出的各微服务的接口信息，并从所展示的各微服务的接口信息中，查找并展示所需的接口信息。
进一步的，所述接口文档收集模块，具体用于获取各微服务的工程地址和接口文档生成地址，其中，针对每一个微服务，该微服务的工程地址包括运行该微服务的设备的IP地址，该微服务的接口文档生成地址为该设备中存储该微服务自动生成的接口文档的存储地址，并且针对每一个微服务，按照该微服务的工程地址和接口文档生成地址，收集该微服务的接口文档。
进一步的，所述接口文档收集模块，具体用于读取配置文件，获取所述配置文件中记录的各微服务的工程地址，并且针对获取的每一个工程地址，确定预先与该工程地址建立有关联关系的接口文档生成地址。
进一步的，所述接口文档收集模块，具体用于针对每一个微服务，根据该微服务的工程地址访问该微服务所在的设备，并且按照该微服务的接口文档生成地址，从该设备中加载出该接口文档生成地址对应存储地址处的该微服务的接口文档。
进一步的，所述接口信息展示模块，具体用于接收展示选择操作，所述展示选择操作用于选择需要进行接口信息展示的微服务，并且根据所述展示选择操作，从解析出的各微服务的接口信息中，查找出所述展示选择操作所选择的微服务的接口信息，作为目标接口信息，以及在预设的界面中，展示所述目标接口信息。
本发明实施例还提供一种电子设备，包括处理器、通信接口、存储器和通信总线，其中，处理器，通信接口，存储器通过通信总线完成相互间的通信；
存储器，用于存放计算机程序；
处理器，用于执行存储器上所存放的程序时，实现上述任一微服务的接口信息展示方法的步骤。
本发明实施还提供了一种计算机可读存储介质，所述计算机可读存储介质内存储有计算机程序，所述计算机程序被处理器执行时实现上述任一微服务的接口信息展示方法的步骤。
本发明实施例还提供了一种包含指令的计算机程序产品，当其在计算机上运行时，使得计算机执行上述任一微服务的接口信息展示方法。
本发明实施例提供的一种微服务接口信息的展示方法、装置及电子设备，方案中，收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息，并且针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息，以及在预设的界面中，展示解析出的各微服务的接口信息，由于集中收集了各微服务的接口文档，并且在同一个界面中就可以查看各微服务的接口信息，使得各微服务的接口信息方便管理。
当然，实施本发明的任一产品或方法并不一定需要同时达到以上所述的所有优点。
附图说明
为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍。
图1为本发明一个实施例提供的微服务的接口信息展示方法的流程图；
图2为本发明一个实施例提供的收集各微服务的接口文档方法的流程图；
图3为本发明一个实施例提供的展示接口信息的方法的流程图；
图4为本发明一个实施例提供的微服务的接口信息展示装置的结构示意图；
图5为本发明实施例提供的电子设备的结构示意图。
具体实施方式
为了给出方便的管理各微服务的接口信息的实现方案，本发明实施例提供了一种微服务的接口信息展示方法、装置及电子设备，以下结合说明书附图对本发明的实施例进行说明。并且在不冲突的情况下，本申请中的实施例及实施例中的特征可以相互组合。
下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述。
在本发明的一个实施例中，提供一种微服务的接口信息展示方法，如图1所示，该方法包括以下步骤：
S101：收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息。
本步骤中，接口文档可以是Swagger框架中Swagger生成器根据各微服务中预设的注解自动生成的，Swagger生成器安装在各微服务所在服务器中。在实际应用过程中，接口文档可以是.json类型的文档或者是.yaml类型的文档。
本领域的技术人员可以理解的是，为了生成各微服务的接口文档，技术人员在进行微服务开发的过程中，就已经在各微服务的相关接口信息处添加了可以被Swagger框架的相关工具识别的注解，其中，上述接口信息可以是微服务的接口URL、请求参数和返回参数等信息，上述Swagger框架的相关工具可以是Swagger生成器。
示例性的，在一个用户登录微服务，前端调用该用户登录微服务的接口URL为http://www.xxxxx.com/home，请求参数可以为前端用户输入的账号、密码和验证码等，返回参数可以是允许登录指令、拒绝登录指令和账号或密码错误指令等，本领域技术人员在开发该用户登录微服务时，可以在开发过程中，在上述各参数添加Swagger框架指定的注解，从而使得Swagger生成器识别到相关注解后，确定需要写入接口文档的接口信息。
在一个实施例中，如图2所示，上述步骤S101还可以包括以下步骤：
S201：获取各微服务的工程地址和接口文档生成地址，其中，针对每一个微服务，该微服务的工程地址包括运行该微服务的设备的IP地址，该微服务的接口文档生成地址为该设备中存储该微服务自动生成的接口文档的存储地址。
本步骤中，可以获取各微服务的工程地址和接口文档生成地址，在实际使用过程中，各微服务可以是在不同的服务器或者设备上开发或者运行的，针对每一个微服务，其所运行的服务器或设备存在唯一的IP地址，并且Swagger框架中的Swagger生成器可以微服务所运行的预设位置处生成接口文档，在一个实施例中，微服务的工程地址还可以包括该微服务的端口，在实际使用过程中，存在一个设备中可以运行多个微服务的情况，此时，对于该设备上的每一个微服务来说，该微服务的工程地址包括该微服务的设备的IP地址和该微服务的端口，通过端口可以在该设备中确定该端口对应的微服务。
在一个实施例中，可以通过读取配置文件，获取配置文件中记录的各微服务的工程地址，本领域的技术人员可以理解，配置文件可以是根据需求设置的，其中配置文件中记录的各微服务的工程地址可以是在各微服务开发之前、开发的过程中或者完成开发后添加的，在一个实施例中，配置文件也可以是网关中现存，本领域技术人员可以理解的是，网关中的配置文件是在进行微服务创建时就已经设置完成的，从网关中获取配置文件可以避免开发人员的手动配置，从而进一步方便的管理各微服务的接口信息。
示例性的，在一个后端项目的开发过程中，拆分为三个微服务：用户登录服务、视频播放服务和用户信息获取服务，上述三个微服务分别在位于不同的服务器上，用户登录服务运行于用户登录服务器，IP地址为192.168.0.X1，视频播放服务运行于视频播放服务器，IP地址为192.168.0.X2，用户信息获取服务运行于用户信息获取服务器，IP地址为192.168.0.X3，则配置文件中，预先记录有上述IP地址，其中，具体的记录格式可以根据需求进行设置。
在一个实施例中，对于每一个工程地址，可以存在一个预设与该工程地址建立有关联关系的接口文档生成地址，其中，接口文档生成地址为微服务所在设备中存储微服务自动生成的接口文档的存储地址，在一个实施例中，接口文档的存储地址可以是根据实际需求进行设置，例如，对于上述用户登录服务的接口文档的存储地址可以设置为/a/swagger/api/doc。本实施例中，可以针对获取的每一个工程地址，确定预先与该工程地址建立有关联关系的接口文档生成地址。
S202：针对每一个微服务，按照该微服务的工程地址和接口文档生成地址，收集该微服务的接口文档。
本步骤中，针对每一个微服务，可以按照上述步骤S1011中获取的微服务的工程地址和接口文档生成地址，收集微服务的接口文档。
在一个实施例中，针对每一个微服务，可以根据该微服务的工程地址访问该微服务所在的设备，并按照该微服务的接口文档生成地址，从该设备中加载出该接口文档生成地址对应存储地址处的该微服务的接口文档。
例如，对于用户登录服务，其运行于用户登录服务器，该用户登录服务器的IP地址为192.168.0.X1，用户登录服务的接口文档生成地址为/a/swagger/api/，则可以通过IP地址192.168.0.X1访问用户登录服务器，并在用户服务器中，在/a/swagger/api/的地址下，收集该地址中存储的接口文档。
S102：针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息。
本步骤中，可以通过Swagger框架提供的工具包对接口文档进行解析，以获取该接口文档所属的微服务的接口信息，在一个实施例中，上述工具包可以是Swagger-UI。
示例性的，针对用户登录服务，其接口文档中记录有接口信息：接口URL＝http://www.xxxxx.com/home，请求参数：用户输入的账号、密码和验证码等，返回参数：允许登录指令、拒绝登录指令和账号或密码错误指令，则可以通过Swagger-UI解析出用户登录微服务的接口文档中包含的上述接口信息。
S103：在预设的界面中，展示解析出的各微服务的接口信息，并从所展示的各微服务的接口信息中，查找并展示所需的接口信息。
本步骤中，预设的界面可以是Swagger框架中Swagger-UI提供的用户界面，在用户界面中可以展示有解析出的所有接口信息，具体的展示形式可以根据实际需求进行设置。
在一个实施例中，还可以通过下述方式在预设的界面中，展示解析出的各微服务的接口信息，本实施例中，可以展示单个用户选择的微服务的接口信息，如图3所示，实现步骤包括：
S301：接收展示选择操作，展示选择操作用于选择需要进行接口信息展示的微服务。
本步骤中，展示选择操作为用户选择的需要进行接口信息展示的微服务，其展示选择操作可以是任意一种现有的人机交互方式，本发明在此不做具体的限定。
S302：根据展示选择操作，从解析出的各微服务的接口信息中，查找出展示选择操作所选择的微服务的接口信息，作为目标接口信息。
本步骤中，选择展示操作所选择的微服务是用户需要查看的接口信息的微服务，根据所选择的微服务，从解析得到的接口信息中，确定所选择的微服务的接口信息。
S303：在预设的界面中，展示目标接口信息。
本步骤中，可以在预设的界面中，所选择的微服务的接口信息，在一个实施例中，当用户需要切换查看其它微服务的接口信息时，可以通过Swagger-UI提供的下拉框进行选择微服务。
本发明实施例提供的上述微服务的接口信息展示方法中，收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息，并且针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息，以及在预设的界面中，展示解析出的各微服务的接口信息，由于集中收集了各微服务的接口文档，并且在同一个界面中就可以查看各微服务的接口信息，使得各微服务的接口信息方便管理。
基于同一发明构思，根据本发明实施例提供的微服务的接口信息展示方法，本发明实施例还提供了一种微服务的接口信息展示装置，如图4所示，该装置包括：
接口文档收集模块401，用于收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息；
接口信息解析模块402，用于针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息；
接口信息展示模块403，用于在预设的界面中，展示解析出的各微服务的接口信息，并从所展示的各微服务的接口信息中，查找并展示所需的接口信息。
进一步的，接口文档收集模块401，具体用于获取各微服务的工程地址和接口文档生成地址，其中，针对每一个微服务，该微服务的工程地址包括运行该微服务的设备的IP地址，该微服务的接口文档生成地址为该设备中存储该微服务自动生成的接口文档的存储地址，并且针对每一个微服务，按照该微服务的工程地址和接口文档生成地址，收集该微服务的接口文档。
进一步的，接口文档收集模块401，具体用于读取配置文件，获取配置文件中记录的各微服务的工程地址，并且针对获取的每一个工程地址，确定预先与该工程地址建立有关联关系的接口文档生成地址。
进一步的，接口文档收集模块401，具体用于针对每一个微服务，根据该微服务的工程地址访问该微服务所在的设备，并且按照该微服务的接口文档生成地址，从该设备中加载出该接口文档生成地址对应存储地址处的该微服务的接口文档。
进一步的，接口信息展示模块403，具体用于接收展示选择操作，展示选择操作用于选择需要进行接口信息展示的微服务，并且根据展示选择操作，从解析出的各微服务的接口信息中，查找出展示选择操作所选择的微服务的接口信息，作为目标接口信息，以及在预设的界面中，展示目标接口信息。
本发明实施例还提供了一种电子设备，如图5所示，包括处理器501、通信接口502、存储器503和通信总线504，其中，处理器501，通信接口502，存储器503通过通信总线504完成相互间的通信，
存储器503，用于存放计算机程序；
处理器501，用于执行存储器503上所存放的程序时，实现如下步骤：
收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息；
针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息；
在预设的界面中，展示解析出的各微服务的接口信息。
上述电子设备提到的通信总线可以是外设部件互连标准(Peripheral ComponentInterconnect，PCI)总线或扩展工业标准结构(Extended Industry StandardArchitecture，EISA)总线等。该通信总线可以分为地址总线、数据总线、控制总线等。为便于表示，图中仅用一条粗线表示，但并不表示仅有一根总线或一种类型的总线。
通信接口用于上述电子设备与其他设备之间的通信。
存储器可以包括随机存取存储器(Random Access Memory，RAM)，也可以包括非易失性存储器(Non-Volatile Memory，NVM)，例如至少一个磁盘存储器。可选的，存储器还可以是至少一个位于远离前述处理器的存储装置。
上述的处理器可以是通用处理器，包括中央处理器(Central Processing Unit，CPU)、网络处理器(Network Processor，NP)等；还可以是数字信号处理器(Digital SignalProcessing，DSP)、专用集成电路(Application Specific Integrated Circuit，ASIC)、现场可编程门阵列(Field-Programmable Gate Array，FPGA)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。
在本发明提供的又一实施例中，还提供了一种计算机可读存储介质，该计算机可读存储介质内存储有计算机程序，所述计算机程序被处理器执行时实现上述任一微服务的接口信息展示方法的步骤。
在本发明提供的又一实施例中，还提供了一种包含指令的计算机程序产品，当其在计算机上运行时，使得计算机执行上述实施例中任一微服务的接口信息展示方法。
在上述实施例中，可以全部或部分地通过软件、硬件、固件或者其任意组合来实现。当使用软件实现时，可以全部或部分地以计算机程序产品的形式实现。所述计算机程序产品包括一个或多个计算机指令。在计算机上加载和执行所述计算机程序指令时，全部或部分地产生按照本发明实施例所述的流程或功能。所述计算机可以是通用计算机、专用计算机、计算机网络、或者其他可编程装置。所述计算机指令可以存储在计算机可读存储介质中，或者从一个计算机可读存储介质向另一个计算机可读存储介质传输，例如，所述计算机指令可以从一个网站站点、计算机、服务器或数据中心通过有线(例如同轴电缆、光纤、数字用户线(DSL))或无线(例如红外、无线、微波等)方式向另一个网站站点、计算机、服务器或数据中心进行传输。所述计算机可读存储介质可以是计算机能够存取的任何可用介质或者是包含一个或多个可用介质集成的服务器、数据中心等数据存储设备。所述可用介质可以是磁性介质，(例如，软盘、硬盘、磁带)、光介质(例如，DVD)、或者半导体介质(例如固态硬盘Solid State Disk(SSD))等。
需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。
本说明书中的各个实施例均采用相关的方式描述，各个实施例之间相同相似的部分互相参见即可，每个实施例重点说明的都是与其他实施例的不同之处。尤其，对于装置、电子设备、计算机可读存储介质、计算机程序产品而言，由于其基本相似于方法实施例，所以描述的比较简单，相关之处参见方法实施例的部分说明即可。
以上所述仅为本发明的较佳实施例而已，并非用于限定本发明的保护范围。凡在本发明的精神和原则之内所作的任何修改、等同替换、改进等，均包含在本发明的保护范围内。

Claims (9)

1.一种微服务的接口信息展示方法，其特征在于，包括：
收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息；
针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息；
在预设的界面中，展示解析出的各微服务的接口信息，并从所展示的各微服务的接口信息中，查找并展示所需的接口信息；
所述收集各微服务的接口文档，包括：
获取各微服务的工程地址和接口文档生成地址，其中，针对每一个微服务，该微服务的工程地址包括运行该微服务的设备的IP地址，该微服务的接口文档生成地址为该设备中存储该微服务自动生成的接口文档的存储地址；
针对每一个微服务，按照该微服务的工程地址和接口文档生成地址，收集该微服务的接口文档。
2.根据权利要求1所述的方法，其特征在于，所述获取各微服务的工程地址和接口文档生成地址，包括：
读取配置文件，获取所述配置文件中记录的各微服务的工程地址；
针对获取的每一个工程地址，确定预先与该工程地址建立有关联关系的接口文档生成地址。
3.根据权利要求1所述的方法，其特征在于，所述针对每一个微服务，按照该微服务的工程地址和接口文档生成地址，收集该微服务的接口文档，包括：
针对每一个微服务，根据该微服务的工程地址访问该微服务所在的设备；
按照该微服务的接口文档生成地址，从该设备中加载出该接口文档生成地址对应存储地址处的该微服务的接口文档。
4.根据权利要求1所述的方法，其特征在于，在所述展示解析出的各微服务的接口信息之前，该方法还包括：
接收展示选择操作，所述展示选择操作用于选择需要进行接口信息展示的微服务；
其中，所述从所展示的各微服务的接口信息中，查找并展示所需的接口信息，包括：
根据所述展示选择操作，从解析出的各微服务的接口信息中，查找出所述展示选择操作所选择的微服务的接口信息，作为目标接口信息；
在预设的界面中，展示所述目标接口信息。
5.一种微服务的接口信息展示装置，其特征在于，包括：
接口文档收集模块，用于收集各微服务的接口文档，其中，针对每一个微服务，该微服务的接口文档为根据该微服务中预设的注解自动生成的，用于记录该微服务的接口信息；
接口信息解析模块，用于针对收集到的每一个接口文档，从该接口文档中解析出该接口文档所属的微服务的接口信息；
接口信息展示模块，用于在预设的界面中，展示解析出的各微服务的接口信息，并从所展示的各微服务的接口信息中，查找并展示所需的接口信息；
所述接口文档收集模块，具体用于获取各微服务的工程地址和接口文档生成地址，其中，针对每一个微服务，该微服务的工程地址包括运行该微服务的设备的IP地址，该微服务的接口文档生成地址为该设备中存储该微服务自动生成的接口文档的存储地址，并且针对每一个微服务，按照该微服务的工程地址和接口文档生成地址，收集该微服务的接口文档。
6.根据权利要求5所述的装置，其特征在于，所述接口文档收集模块，具体用于读取配置文件，获取所述配置文件中记录的各微服务的工程地址，并且针对获取的每一个工程地址，确定预先与该工程地址建立有关联关系的接口文档生成地址。
7.根据权利要求5所述的装置，其特征在于，所述接口文档收集模块，具体用于针对每一个微服务，根据该微服务的工程地址访问该微服务所在的设备，并且按照该微服务的接口文档生成地址，从该设备中加载出该接口文档生成地址对应存储地址处的该微服务的接口文档。
8.根据权利要求5所述的装置，其特征在于，所述接口信息展示模块，具体用于接收展示选择操作，所述展示选择操作用于选择需要进行接口信息展示的微服务，并且根据所述展示选择操作，从解析出的各微服务的接口信息中，查找出所述展示选择操作所选择的微服务的接口信息，作为目标接口信息，以及在预设的界面中，展示所述目标接口信息。
9.一种电子设备，其特征在于，包括处理器、通信接口、存储器和通信总线，其中，处理器，通信接口，存储器通过通信总线完成相互间的通信；
存储器，用于存放计算机程序；
处理器，用于执行存储器上所存放的程序时，实现权利要求1-4任一所述的方法步骤。
CN201910555524.XA 2019-06-25 2019-06-25 一种微服务的接口信息展示方法、装置及电子设备 Active CN110321154B (zh)

Priority Applications (1)

Application Number Priority Date Filing Date Title
CN201910555524.XA CN110321154B (zh) 2019-06-25 2019-06-25 一种微服务的接口信息展示方法、装置及电子设备

Applications Claiming Priority (1)

Application Number Priority Date Filing Date Title
CN201910555524.XA CN110321154B (zh) 2019-06-25 2019-06-25 一种微服务的接口信息展示方法、装置及电子设备

Publications (2)

Publication Number Publication Date
CN110321154A CN110321154A (zh) 2019-10-11
CN110321154B true CN110321154B (zh) 2023-04-21

Family

ID=68120218

Family Applications (1)

Application Number Title Priority Date Filing Date
CN201910555524.XA Active CN110321154B (zh) 2019-06-25 2019-06-25 一种微服务的接口信息展示方法、装置及电子设备

Country Status (1)

Country Link
CN (1) CN110321154B (zh)

Families Citing this family (7)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN111176660A (zh) * 2019-12-31 2020-05-19 中信百信银行股份有限公司 一种面向分布式架构的微服务契约管理方法、装置、计算机设备、和可读存储介质
CN113535531A (zh) * 2020-04-14 2021-10-22 浙江大搜车软件技术有限公司 一种接口文档的生成方法、接口测试方法和装置
CN111611173A (zh) * 2020-05-27 2020-09-01 中航信移动科技有限公司 一种应用于微服务工程接口文档检测的系统和方法
CN112230891A (zh) * 2020-10-12 2021-01-15 中国民航信息网络股份有限公司 接口文档的集成方法、装置、服务器及计算机存储介质
CN112583891B (zh) * 2020-11-19 2021-07-06 联通智网科技有限公司 接口文档获取方法、装置和服务器
CN112783837B (zh) * 2021-01-12 2024-01-30 北京首汽智行科技有限公司 一种api文档查找方法
CN112988872A (zh) * 2021-03-31 2021-06-18 北京大米科技有限公司 一种接口文档管理方法、装置、存储介质及电子设备

Family Cites Families (6)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN103473045A (zh) * 2013-08-27 2013-12-25 广州华多网络科技有限公司 一种生成接口文档的方法及装置
US10862979B2 (en) * 2017-04-07 2020-12-08 Microsoft Technology Licensing, Llc Techniques for supporting remote micro-services as native functions in spreadsheet applications
US20190034210A1 (en) * 2017-07-28 2019-01-31 Kong Inc. Systems and methods for distributed api gateways
CN107493344B (zh) * 2017-08-29 2020-07-28 浪潮云信息技术股份公司 一种Web访问Docker容器的方法及系统
CN107885499A (zh) * 2017-10-19 2018-04-06 平安壹钱包电子商务有限公司 一种接口文档生成方法及终端设备
CN109375901A (zh) * 2018-09-03 2019-02-22 平安普惠企业管理有限公司 接口信息管理方法、装置、计算机设备以及存储介质

Also Published As

Publication number Publication date
CN110321154A (zh) 2019-10-11

Similar Documents

Publication Publication Date Title
CN110321154B (zh) 一种微服务的接口信息展示方法、装置及电子设备
US9292311B2 (en) Method and apparatus for providing software problem solutions
US8731998B2 (en) Three dimensional visual representation for identifying problems in monitored model oriented business processes
US10362086B2 (en) Method and system for automating submission of issue reports
CN105099811A (zh) 一种接口测试方法和装置
CN110798380B (zh) 一种数据获取方法、系统、装置、测试设备及测试服务器
US9910858B2 (en) System and method for providing contextual analytics data
US8639560B2 (en) Brand analysis using interactions with search result items
US10705949B2 (en) Evaluation of library test suites using mutation testing
US8407766B1 (en) Method and apparatus for monitoring sensitive data on a computer network
JP2021519960A (ja) ウェブトラフィックデータを処理および管理するシステム、装置、および方法
CN111694561A (zh) 一种接口管理方法、装置、设备及存储介质
CN112541002A (zh) 程序语言转换方法、装置、电子设备及存储介质
CN109862074B (zh) 一种数据采集方法、装置、可读介质及电子设备
US20150142894A1 (en) Interactive splitting of entries in social collaboration environments
CN110162982B (zh) 检测非法权限的方法及装置、存储介质、电子设备
CN105912573A (zh) 数据更新方法及装置
CN113792138B (zh) 报表生成方法、装置、电子设备及存储介质
KR20090060840A (ko) 연관 컨텐츠 제공 방법
CN111367703B (zh) 故障排查方法及装置
JP2013196547A (ja) 情報処理装置及び情報処理プログラム
CN112416713A (zh) 操作审计系统及方法、计算机可读存储介质、电子设备
CN110750569A (zh) 数据提取方法、装置、设备及存储介质
CN113360364B (zh) 目标对象的测试方法及装置
US11630946B2 (en) Documentation augmentation using role-based user annotations

Legal Events

Date Code Title Description
PB01 Publication
PB01 Publication
SE01 Entry into force of request for substantive examination
SE01 Entry into force of request for substantive examination
GR01 Patent grant
GR01 Patent grant