CN117519837B - 一种接口管理方法及接口管理系统 - Google Patents

一种接口管理方法及接口管理系统 Download PDF

Info

Publication number
CN117519837B
CN117519837B CN202410001121.1A CN202410001121A CN117519837B CN 117519837 B CN117519837 B CN 117519837B CN 202410001121 A CN202410001121 A CN 202410001121A CN 117519837 B CN117519837 B CN 117519837B
Authority
CN
China
Prior art keywords
interface
target
acquisition
strategy
item
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
CN202410001121.1A
Other languages
English (en)
Other versions
CN117519837A (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.)
DMAI Guangzhou Co Ltd
Original Assignee
DMAI Guangzhou 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 DMAI Guangzhou Co Ltd filed Critical DMAI Guangzhou Co Ltd
Priority to CN202410001121.1A priority Critical patent/CN117519837B/zh
Publication of CN117519837A publication Critical patent/CN117519837A/zh
Application granted granted Critical
Publication of CN117519837B publication Critical patent/CN117519837B/zh
Active legal-status Critical Current
Anticipated expiration legal-status Critical

Links

Classifications

    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F9/00Arrangements for program control, e.g. control units
    • G06F9/06Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
    • G06F9/44Arrangements for executing specific programs
    • G06F9/445Program loading or initiating
    • G06F9/44505Configuring for program initiating, e.g. using registry, configuration files
    • YGENERAL TAGGING OF NEW TECHNOLOGICAL DEVELOPMENTS; GENERAL TAGGING OF CROSS-SECTIONAL TECHNOLOGIES SPANNING OVER SEVERAL SECTIONS OF THE IPC; TECHNICAL SUBJECTS COVERED BY FORMER USPC CROSS-REFERENCE ART COLLECTIONS [XRACs] AND DIGESTS
    • Y02TECHNOLOGIES OR APPLICATIONS FOR MITIGATION OR ADAPTATION AGAINST CLIMATE CHANGE
    • Y02DCLIMATE CHANGE MITIGATION TECHNOLOGIES IN INFORMATION AND COMMUNICATION TECHNOLOGIES [ICT], I.E. INFORMATION AND COMMUNICATION TECHNOLOGIES AIMING AT THE REDUCTION OF THEIR OWN ENERGY USE
    • Y02D10/00Energy efficient computing, e.g. low power processors, power management or thermal management

Landscapes

  • Engineering & Computer Science (AREA)
  • Software Systems (AREA)
  • Theoretical Computer Science (AREA)
  • Physics & Mathematics (AREA)
  • General Engineering & Computer Science (AREA)
  • General Physics & Mathematics (AREA)
  • User Interface Of Digital Computer (AREA)

Abstract

本申请提供了一种接口管理方法及接口管理系统,其中,该方法包括:通过前端设备提供接口管理界面,所述方法包括:响应于配置接口的请求操作,在所述接口管理界面上显示获取策略配置项和接口信息配置项,所述获取策略配置项用于配置在接口被调用时获取响应数据的策略,所述接口信息配置项用于配置策略对应的接口;响应于对所述获取策略配置项的选择操作,确定目标获取策略;响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口;将所述目标获取策略及对应的目标接口进行保存,以完成对目标接口及对应的目标获取策略的配置。

Description

一种接口管理方法及接口管理系统
技术领域
本申请涉及软件开发技术领域,尤其涉及一种接口管理方法及接口管理系统。
背景技术
在前后端分离以及微服务的软件开发模式中,用户经常需要手动配置和调用后端接口,导致耗时且容易出错的问题。且由于项目中所需的接口数量较大,从而提高了故障概率,并且增加了维护成本。而在后端服务器无法调用接口时,无法得到调用后端接口所得到的响应数据,影响开发的进程。
发明内容
有鉴于此,本申请的目的在于至少提供一种接口管理方法及接口管理系统,通过设置接口管理界面并预先配置好每个接口被调用时获取响应数据的策略,从而用户可以针对实际应用的情况对每个接口对应的策略进行配置,解决了现有技术中在后端服务器无法调用接口时导致的无法获取响应数据的技术问题,达到提高获取响应数据的效率的技术效果。
本申请主要包括以下几个方面:
第一方面,本申请实施例提供一种接口管理方法,通过前端设备提供接口管理界面,所述方法包括:响应于配置接口的请求操作,在所述接口管理界面上显示获取策略配置项和接口信息配置项,所述获取策略配置项用于配置在接口被调用时获取响应数据的策略,所述接口信息配置项用于配置策略对应的接口;响应于对所述获取策略配置项的选择操作,确定目标获取策略;响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口;将所述目标获取策略及对应的目标接口进行保存,以完成对目标接口及对应的目标获取策略的配置。
可选地,所述获取策略配置项包括:实时获取策略、预存数据获取策略和组合获取策略,所述目标获取策略为实时获取策略、预存数据获取策略和组合获取策略中的一个,其中,所述实时获取策略指的是在接口被调用时通过对应的后端服务器获取响应数据的获取策略,所述预存数据获取策略指的是在接口被调用时将对应的预存数据作为所获取的响应数据的获取策略,所述组合获取策略指的是在预设时间段内接口被调用时将对应的预存数据作为所获取的响应数据,以及在除预设时间段之外的接口被调用时通过对应的后端服务器获取响应数据的获取策略。
可选地,所述接口信息配置项包括服务配置项和接口配置项,所述响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口,包括:响应于对所述服务配置项的选择操作,在至少一个预设服务中确定出目标服务,每个预设服务对应至少一个接口;响应于对所述接口配置项的选择操作,在所述目标服务对应的至少一个接口中选择目标接口。
可选地,所述方法还包括:在确定所述目标获取策略为组合获取策略时,在所述接口管理界面上显示预设时间段配置项;响应于对所述预设时间段配置项的配置指令,以对所述预设时间段进行配置。
可选地,确定与所述目标获取策略对应的至少一个目标接口之后,所述方法还包括:在所述接口管理界面上显示每个目标接口对应的预存数据列表,所述预存数据列表包括预先存储的目标接口的每条历史响应数据,每条历史响应数据对应修改项和确认项;针对目标接口的每条历史响应数据,响应于对该历史响应数据的所述修改项的选择指令,以对该条历史响应数据进行修改;针对目标接口的每条历史响应数据,响应于对该历史响应数据的所述确认项的选择指令,以在该目标接口的所述获取策略配置项为预存数据项且该目标接口被调用时,将该历史响应数据发送至所述前端设备进行显示。
可选地,所述接口管理界面还包括策略列表和接口列表,所述方法还包括:响应于对所述策略列表的选择指令,在所述接口管理界面中显示所述获取策略配置项中的每个获取策略及对应的操作项,获取策略对应的操作项用于指示用户对每个获取策略所执行的操作,响应于对每个获取策略的目标操作项的选择指令,以执行每个获取策略的目标操作,和/或,响应于对所述接口列表的选择指令,在所述接口管理界面中显示每个接口及对应的操作项,接口对应的操作项用于指示用户对每个接口所执行的操作,响应于对每个接口的目标操作项的选择指令,以执行每个接口的目标操作。
第二方面,本申请实施例还提供一种接口管理系统,所述接口管理系统包括前端设备和代理服务器,其中,所述前端设备,用于显示接口管理界面;所述代理服务器,用于执行上述第一方面或第一方面中任一种可能的实施方式中所述的接口管理方法。
可选地,所述前端设备,还用于将用户针对待调用接口的调用指令发送至所述代理服务器;所述代理服务器,还用于响应于所述调用指令,确定所述待调用接口对应的目标获取策略,依据所述目标获取策略,确定针对所述待调用接口的响应数据。
可选地,所述接口管理系统还包括后端服务器,其中,所述代理服务器,还用于在所述目标获取策略为实时获取策略时,将所述调用指令发送至后端服务器,在所述目标获取策略为组合获取策略时,在预设时间段之后将所述调用指令发送至后端服务器;所述后端服务器,用于依据所述调用指令确定针对所述待调用接口的响应数据,将所述响应数据发送至所述代理服务器,以使所述代理服务器将所述响应数据发送至所述前端设备。
可选地,所述接口管理系统还包括代码生成器和前端服务器,所述前端设备,还用于将用户针对候选应用程序接口的应用程序接口文件发送至所述代码生成器;所述代码生成器,还用于解析所述应用程序接口文件以生成所述候选应用程序接口对应的代码函数库,将代码函数库发送至前端服务器,以便于所述前端服务器应用所述代码函数库。
第三方面,本申请实施例还提供一种电子设备,包括:处理器、存储器和总线,所述存储器存储有所述处理器可执行的机器可读指令,当电子设备运行时,所述处理器与所述存储器之间通过所述总线进行通信,所述机器可读指令被所述处理器运行时执行上述第一方面或第一方面中任一种可能的实施方式中所述的接口管理方法的步骤。
第四方面,本申请实施例还提供了一种计算机可读存储介质,所述计算机可读存储介质上存储有计算机程序,所述计算机程序被处理器运行时执行上述第一方面或第一方面中任一种可能的实施方式中所述的接口管理方法的步骤。
本申请实施例提供的一种接口管理方法及接口管理系统,通过前端设备提供接口管理界面,所述方法包括:响应于配置接口的请求操作,在所述接口管理界面上显示获取策略配置项和接口信息配置项,所述获取策略配置项用于配置在接口被调用时获取响应数据的策略,所述接口信息配置项用于配置策略对应的接口;响应于对所述获取策略配置项的选择操作,确定目标获取策略;响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口;将所述目标获取策略及对应的目标接口进行保存,以完成对目标接口及对应的目标获取策略的配置。通过设置接口管理界面并预先配置好每个接口被调用时获取响应数据的策略,从而用户可以针对实际应用的情况对每个接口对应的策略进行配置,解决了现有技术中在后端服务器无法调用接口时导致的无法获取响应数据的技术问题,达到提高获取响应数据的效率的技术效果。
为使本申请的上述目的、特征和优点能更明显易懂,下文特举较佳实施例,并配合所附附图,作详细说明如下。
附图说明
为了更清楚地说明本申请实施例的技术方案,下面将对实施例中所需要使用的附图作简单地介绍,应当理解,以下附图仅示出了本申请的某些实施例,因此不应被看作是对范围的限定,对于本领域普通技术人员来讲,在不付出创造性劳动的前提下,还可以根据这些附图获得其他相关的附图。
图1示出了本申请实施例所提供的一种接口管理方法的流程图。
图2示出了本申请实施例所提供的一种接口管理系统的交互图。
图3示出了本申请实施例所提供的一种接口管理系统的处理流程图。
图4示出了本申请实施例所提供的一种电子设备的结构示意图。
具体实施方式
为使本申请实施例的目的、技术方案和优点更加清楚,下面将结合本申请实施例中的附图,对本申请实施例中的技术方案进行清楚、完整地描述,应当理解,本申请中的附图仅起到说明和描述的目的,并不用于限定本申请的保护范围。另外,应当理解,示意性的附图并未按实物比例绘制。本申请中使用的流程图示出了根据本申请的一些实施例实现的操作。应当理解,流程图的操作可以不按顺序实现,没有逻辑的上下文关系的步骤可以反转顺序或者同时实施。此外,本领域技术人员在本申请内容的指引下,可以向流程图添加一个或多个其他操作,也可以从流程图中移除一个或多个操作。
另外,所描述的实施例仅仅是本申请一部分实施例,而不是全部的实施例。通常在此处附图中描述和示出的本申请实施例的组件可以以各种不同的配置来布置和设计。因此,以下对在附图中提供的本申请的实施例的详细描述并非旨在限制要求保护的本申请的范围,而是仅仅表示本申请的选定实施例。基于本申请的实施例,本领域技术人员在没有做出创造性劳动的前提下所获得的全部其他实施例,都属于本申请保护的范围。
在前后端分离以及微服务的软件开发模式中,用户经常需要手动配置和调用后端接口,由于接口的数量较多,这不仅耗时,而且容易出错,并且增加了用户的工作量及维护成本。现有的代码生成器只能实现生成代码,并且大多数工具的使用需要进行二次开发,增加了项目的复杂性,以及造成耦合问题,对于接口调用所得到的响应数据用户自行实现缓存、错误处理等功能会增加项目的复杂性和维护成本,大多数工具更侧重于 API(Application Programming Interface,应用程序编程接口)的整体生命周期管理,忽略了如何整体提升软件开发人员之间的协同效率。
基于此,本申请实施例提供了一种接口管理方法及接口管理系统,通过设置接口管理界面并预先配置好每个接口被调用时获取响应数据的策略,从而用户可以针对实际应用的情况对每个接口对应的策略进行配置,解决了现有技术中在后端服务器无法调用接口时导致的无法获取响应数据的技术问题,达到提高获取响应数据的效率的技术效果,具体如下:
请参阅图1,图1为本申请实施例所提供的一种接口管理方法的流程图。如图1所示,本申请实施例提供的接口管理方法,通过前端设备提供接口管理界面,接口管理方法应用于代理服务器,包括以下步骤:
S101:响应于配置接口的请求操作,在所述接口管理界面上显示获取策略配置项和接口信息配置项。
本申请中的接口指的是API(Application Programming Interface,应用程序编程接口)。所述获取策略配置项用于配置在接口被调用时获取响应数据的策略,所述接口信息配置项用于配置策略对应的接口。
示例性的,在前端设备的接口管理界面中显示配置接口对应的按键,用户通过点击配置接口对应的按键,来触发配置接口请求,进而,响应于配置接口的请求操作,以在所述接口管理界面上显示获取策略配置项和接口信息配置项,以便于用户进行配置。前端设备指的是具备显示功能且用于配置接口的界面载体。
S102:响应于对所述获取策略配置项的选择操作,确定目标获取策略。
所述获取策略配置项包括:实时获取策略、预存数据获取策略和组合获取策略,所述目标获取策略为实时获取策略、预存数据获取策略和组合获取策略中的一个。
其中,所述实时获取策略指的是在接口被调用时通过对应的后端服务器获取响应数据的获取策略,所述预存数据获取策略指的是在接口被调用时将对应的预存数据作为所获取的响应数据的获取策略,所述组合获取策略指的是在预设时间段内接口被调用时将对应的预存数据作为所获取的响应数据,以及在除预设时间段之外的接口被调用时通过对应的后端服务器获取响应数据的获取策略。
预存数据指的是预先存储的接口被历史调用时所获取的历史响应数据。
也就是说,响应于对目标获取策略的选择操作,在实时获取策略、预存数据获取策略和组合获取策略中确定出目标获取策略。
示例性的,用户点击获取策略配置项后,显示出实时获取策略、预存数据获取策略和组合获取策略,用户通过点击实时获取策略、预存数据获取策略和组合获取策略中的一个来选择目标获取策略,从而,便于用户配置目标获取策略对应的目标接口。
所述方法还包括:在确定所述目标获取策略为组合获取策略时,在所述接口管理界面上显示预设时间段配置项;响应于对所述预设时间段配置项的配置指令,以对所述预设时间段进行配置。
也就是说,配置预设时间段之后,若目标接口对应的目标获取策略为组合获取策略,则在预设时间段内调用目标接口时,将该目标接口对应的预存数据作为所获取的响应数据,在除预设时间段之外的接口被调用时通过对应的后端服务器获取响应数据。
设置预设时间段是为了在后端服务器出现异常时,将预存数据作为响应数据来防止影响开发进度。还可以在接口管理界面上设置通知推送,在后端服务器产生异常时,通过通知推送告知用户,以便于用户修改预设时间段。
S103:响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口。
也就是说,在确定目标获取策略之后,响应于对接口信息配置项的选择操作,从而确定与所述目标获取策略对应的至少一个目标接口。针对与所述目标获取策略对应的每个目标接口,该目标接口被调用时按照对应的目标获取策略来获取针对该目标接口的响应数据。
所述接口信息配置项包括服务配置项和接口配置项,所述响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口,包括:响应于对所述服务配置项的选择操作,在至少一个预设服务中确定出目标服务,每个预设服务对应至少一个接口;响应于对所述接口配置项的选择操作,在所述目标服务对应的至少一个接口中选择目标接口。
也就是说,在确定目标获取策略之后,响应于对所述服务配置项的选择操作,在接口管理界面上显示出至少一个预设服务,响应于对目标服务的选择操作,确定出目标服务,响应于对接口配置项的选择操作,在目标服务对应的至少一个接口中确定出目标接口。从而,配置出目标获取策略对应的目标接口。
预设服务指的是接口所对应的微服务,一个预设服务对应多个接口,一个接口也可能对应多个预设服务。从而,可以配置出目标获取策略对应的至少一个目标服务,及每个目标服务对应的至少一个目标接口。
示例性的,所述接口管理界面还包括优先级配置项,优先级配置项用于配置目标获取策略的优先级,从而,以便于在一个目标接口对应的目标获取策略的数量大于一时,依据各个目标获取策略的优先级确定出目标接口对应的一个目标获取策略。
具体的,在确定目标获取策略之后,所述方法还包括:响应于对优先级配置项的配置操作,以确定出目标获取策略的优先级。一般的,实时获取策略、预存数据获取策略和组合获取策略分别对应的优先级不相同。
示例性的,通过以下方式确定目标服务:在确定目标获取策略之后,响应于对所述服务配置项的选择操作,在接口管理界面上显示出服务范围配置项,所述服务范围配置项用于指示目标服务的范围,所述服务配置项包括全局级和项目级;响应于对全局级的选择操作,在接口管理界面上显示出全局级对应的至少一个预设服务,或者,响应于对项目级的选择操作,在接口管理界面上显示出项目级对应的至少一个预设服务;响应于对至少一个预设服务中的目标服务的选择操作,在接口管理界面上显示出目标服务对应的所有接口;响应于对目标服务对应的所有接口中的目标接口的选择操作,以选择出目标接口。
或者说,全局级对应的预设服务可以理解为全局下对应的所有的预设服务,项目级对应的预设服务可以理解为单一项目下对应的所有的预设服务,从而便于用户针对实际应用情况进行配置。全局级对应的预设服务包括项目级对应的预设服务。
区分全局级和项目级的目的可以理解为,在目标获取策略对应的目标接口的数量过多时,可以通过配置目标获取策略的优先级以及选择全局级的方式来减少用户的配置操作。或者说,若目标获取策略对应的服务范围配置项为全局级,则认为该目标获取策略为默认的获取策略。
示例性的,若实时获取策略对应的目标接口的数量远大于预存数据获取策略对应的目标接口,也远大于组合获取策略对应的目标接口时,则在确定目标获取策略为实时获取策略之后,选择服务范围配置项为全局级,可以将全局级对应的所有的预设服务作为目标服务,将目标服务下的所有接口作为目标接口,并配置实时获取策略的优先级最低;在配置预存数据获取策略对应的目标接口和组合获取策略对应的目标接口时,则预存数据获取策略对应的选择服务范围配置项为项目级,针对性的选择目标项目及对应的目标接口,并配置预存数据获取策略的优先级高于实时获取策略的优先级,组合获取策略的目标接口的配置同理,从而防止配置时间过长,以提高用户的配置效率。
示例性的,软件开发人员在前端设备的接口管理界面中点击配置接口对应的按键,所述接口管理界面上显示出获取策略配置项和接口信息配置项,软件开发人员在获取策略配置项中的实时获取策略、预存数据获取策略和组合获取策略中选择出目标获取策略配置项并且配置目标获取策略对应的优先级,以及在接口信息配置项的服务配置项中选择出与目标获取策略配置项对应的目标服务,并且目标服务下的接口配置项中选择出对应的目标接口,以完成针对目标获取策略的目标服务及目标接口的配置操作。
示例性的,所述服务配置项还包括单一接口,在确定目标获取策略之后,响应于对所述服务配置项的选择操作,在接口管理界面上显示出服务范围配置项,响应于对单一接口的选择操作,在接口管理界面上显示出各个单一接口;响应于对各个单一接口中的目标接口的选择操作,以选择出目标接口。从而,在配置目标获取策略对应的目标接口的数量很少时,则用户可以直接选择单一接口,从而直接配置目标获取策略对应的目标接口,以提高用户的配置效率。
或者说,按照目标获取策略对应的目标接口的数量进行升序排列,将排列的结果作为目标获取策略的优先级的降序排列结果。也就是说,在目标获取策略对应的目标接口的数量越小时,该目标获取策略的优先级越高,从而便于用户进行配置。
确定与所述目标获取策略对应的至少一个目标接口之后,所述方法还包括:在所述接口管理界面上显示每个目标接口对应的预存数据列表,所述预存数据列表包括预先存储的目标接口的每条历史响应数据,每条历史响应数据对应修改项和确认项;针对目标接口的每条历史响应数据,响应于对该历史响应数据的所述修改项的选择指令,以对该条历史响应数据进行修改;针对目标接口的每条历史响应数据,响应于对该历史响应数据的所述确认项的选择指令,以在该目标接口的所述获取策略配置项为预存数据项且该目标接口被调用时,将该历史响应数据发送至所述前端设备进行显示。
也就是说,目标接口对应的预存数据列表中包括至少一条历史响应数据,用户可以针对每条历史响应数据进行修改,并且在至少一条历史响应数据中选择出目标历史响应数据。目标历史响应数据用于在目标接口的获取策略配置项为预存数据项且目标接口被调用时,将目标历史响应数据发送至所述前端设备进行显示。
也就是说,代理服务器用于存储每个目标接口对应的至少一条历史响应数据。其中,修改的历史响应数据或者未修改的历史响应数据可以作为模拟真实数据源的数据,也就是说作为mock数据,而解决mock数据对实际的工程代码有侵入的技术问题。也就是说,通过对历史响应数据进行存储来实现mock,无须手动配置,也对工程代码无侵入。
所述接口管理界面还包括策略列表和接口列表,所述方法还包括:响应于对所述策略列表的选择指令,在所述接口管理界面中显示所述获取策略配置项中的每个获取策略及对应的操作项,获取策略对应的操作项用于指示用户对每个获取策略所执行的操作,响应于对每个获取策略的目标操作项的选择指令,以执行每个获取策略的目标操作,和/或,响应于对所述接口列表的选择指令,在所述接口管理界面中显示每个接口及对应的操作项,接口对应的操作项用于指示用户对每个接口所执行的操作,响应于对每个接口的目标操作项的选择指令,以执行每个接口的目标操作。
针对每个获取策略,该获取策略对应的操作项包括编辑、启用和删除,若目标操作项为编辑,则响应于对该获取策略的编辑指令,来编辑该获取策略;若目标操作项为启用,则响应于对该获取策略的启用指令,在获取策略配置项中设置该获取策略;若目标操作项为删除,则响应于对该获取策略的删除指令,在获取策略配置项中删除该获取策略。
针对每个接口,该接口对应的操作项包括查看策略及详情,若目标操作项为查看策略,则响应于对查看策略的选择指令,显示出该接口对应的目标获取策略;若目标操作项为详情,则响应于对详情的选择指令,显示出该接口的接口文档、所属的项目、被调用的时间等接口相关的信息。
也就是说,可将满足OpenAPI(开放平台)规范的接口文档或者说swagger json生成的接口文档存储至代理服务器中,以便于代理服务器明确各个接口。
S104:将所述目标获取策略及对应的目标接口进行保存,以完成对目标接口及对应的目标获取策略的配置。
也就是说,响应于对目标获取策略及对应的目标接口的保存操作,以实现对目标获取策略及对应的目标接口的配置。
基于同一申请构思,本申请实施例中还提供了与上述实施例提供的接口管理方法对应的接口管理系统,由于本申请实施例中的接口管理系统解决问题的原理与本申请上述实施例的接口管理方法相似,因此接口管理系统的实施可以参见接口管理方法的实施,重复之处不再赘述。
请参阅图2,图 2为本申请实施例所提供的一种接口管理系统的交互图,所述接口管理系统包括前端设备101和代理服务器102,其中,所述前端设备,用于显示接口管理界面;所述代理服务器,用于执行如上述实施例中任一所述的接口管理方法。
S201:将用户针对待调用接口的调用指令发送至所述代理服务器。
也就是说,所述前端设备,还用于接收用户针对待调用接口的调用指令,并将调用指令发送至所述代理服务器。用户指的是软件开发人员。
S202:响应于所述调用指令,确定所述待调用接口对应的目标获取策略,依据所述目标获取策略,确定针对所述待调用接口的响应数据。
所述代理服务器,还用于响应于所述调用指令,确定所述待调用接口对应的目标获取策略,依据所述目标获取策略,确定针对所述待调用接口的响应数据。
也就是说,用户确定待调用接口后通过前端设备告知代理服务器,从而代理服务器依据待调用接口预先配置好的目标获取策略,来确定针对待调用接口获取响应数据的获取策略。代理服务器的数据库用于存储预存数据、接口列表等接口相关的信息。
所述接口管理系统还包括后端服务器103。
S203:将所述调用指令发送至后端服务器。
也就是说,所述代理服务器,还用于在所述目标获取策略为实时获取策略时,将所述调用指令发送至后端服务器,在所述目标获取策略为组合获取策略时,在预设时间段之后将所述调用指令发送至后端服务器;所述后端服务器,用于依据所述调用指令确定针对所述待调用接口的响应数据,将所述响应数据发送至所述代理服务器,以使所述代理服务器将所述响应数据发送至所述前端设备。
也就是说,若待调用接口的目标获取策略为实时获取策略,则代理服务器将调用指令发送至后端服务器,以使后端服务器将待调用接口对应的响应数据通过代理服务器发送至前端设备;若待调用接口的目标获取策略为组合获取策略,则在预设时间段之内将所述待调用接口对应的预存数据作为响应数据发送至所述前端设备,在预设时间段之后将所述调用指令发送至后端服务器,以使后端服务器将待调用接口对应的响应数据通过代理服务器发送至前端设备;在所述目标获取策略为预存数据获取策略时,将所述待调用接口对应的预存数据作为响应数据发送至所述前端设备。
所述接口管理系统还包括代码生成器104。
S204:将用户针对候选应用程序接口的应用程序接口文件发送至所述代码生成器。
所述前端设备,还用于接收用户针对候选应用程序接口的应用程序接口文件,将所述应用程序接口文件发送至所述代码生成器。
S205:解析所述应用程序接口文件以生成所述候选应用程序接口对应的代码函数库。
所述代码生成器,还用于解析所述应用程序接口文件以生成所述候选应用程序接口对应的代码函数库。
也就是说,若需要编写调用候选应用程序接口(候选API)的代码函数库,则将候选应用程序接口的应用程序接口文件发送至代码生成器,应用程序接口文件是遵循open api规范的json数据文件url,以使代码生成器输出候选API对应的代码函数库,代码函数库是具有良好命名规则的接口函数以及后端服务地址设定函数(用以在应用中配置开发环境、测试环境等不同的环境)的策略,并根据预设模板来适配不同的编程语言。
代码生成器应包括函数签名规则模块、用户配置解析模块和预设模板模块,其中,函数签名规则模块用于对生成代码函数库设定命名规则,用户配置解析模块用于对接口文档进行解析,预设模板模块用于确定预设模板以适配编程语言。
从而,用户通过简单的配置遵循openapi规范(现代后端工程开发普通已支持这种接口文档生成协议)的文档数据url地址,即可生成可直接调用的代码函数库,在工程代码中调用后端接口的逻辑就变得非常轻松。相对于传统的手工编写代码来定义的方式来说,提高效率,并且无论接口的数量是多少,只需要对接口进行配置即可,接口文档直接进行更新,可以自动生成代码函数库。
所述接口管理系统还包括前端服务器105。所述前端服务器为各个接口分别对应的预设服务的服务器,各个预设服务集成为前端工程,软件开发人员操作前端工程选择执行某一项预设服务,从而前端工程向代理服务器来调用接口,代理服务器通过确定调用接口对应的获取策略来确定向后端服务器调用实时的接口数据或者是将调用接口对应的预存接口发送至前端工程。
S206:将代码函数库发送至前端服务器,以便于所述前端服务器应用所述代码函数库。
也就是说,用户需要代码生成器编程应用在前端工程中代码函数库时,且代码函数库用于调用候选应用程序接口,进而用户通过前端设备将针对候选应用程序接口的应用程序接口文件发送至所述代码生成器,以使代码生成器将生成的代码函数库发送至前端服务器,以便于用于将所述代码生成器生成的代码函数库应用在前端工程中,以减少人工编写代码而带来的各种问题。
通过自动化生成代码,避免了不必要的依赖和冗余代码,从而生成的代码库更为精简,可以提高应用的运行速度和响应时间。通过系统化的开发工具,相比于需要多个工具或服务的解决方案更为经济,以减少开发成本。代码生成器生成的代码遵循良好的命名规范和编程实践,这使得代码更易于阅读和维护,以及减少了手动编写和维护代码,减少了长期的维护成本。
并且,由于本申请是综合使用代码生成器和接口管理,两者相辅相成,浑然一体,则能够很好地助力软件开发人员进行通过接口协同各个子模块和外部服务的开发工作。它能够很好地解决前后端协作的问题。另外,它在编程领域具有通用性,也可以解决在开发阶段多个服务之间接口互通的阻碍。在后端微服务的开发领域,不同的服务往往是不同的人员负责的,大家通过接口文档来了解不同服务之间的对接方式,通过配置目标获取策略可以防止后端服务器故障而影响操作,亦可用于处理部分不符合预期的接口返回数据。
请参阅图3,图 3为本申请实施例所提供的一种接口管理系统的处理流程图。如图3所示,用户通过接口管理系统的处理流程包括:
S301:用户提供API文档给代码生成器,以通过所述代码生成器获取的代码函数库。
也就是说,用户对代码生成器输入API文档的URL或文件(如 Swagger或YAPI),文档包含用户所需的API调用函数,代码生成器对API文档进行解析并生成代码函数库,从而代码生成器输出包含API调用函数的代码函数库,从而得到用户所需的具有良好命名规范的函数,并且可以生成独立的代码函数库,除非必要可以不依赖其他库。
S302:用户通过接口管理界面对API进行配置,以配置各API对应的调用策略并存储对应的调用策略。
用户通过接口管理界面对接口的调用策略进行配置、查看和管理其对应的缓存数据,通过在接口管理界面上执行对应的操作,以展示接口列表及各接口对应的缓存数据,并且配置接口对应的调用策略。
S303:用户在前端项目中使用生成的代码函数库,以使API被调用时根据配置的调用策略决定是否调用预存数据。
进而,用户在进行API调用时,根据配置的调用策略确定所调用的API是否使用预先存储的缓存数据,若所调用的API对应的配置为使用预存数据,则输出预存数据,若所调用的API对应的配置不是使用预存数据,则直接调用对应的API接口来获取数据,从而将预存数据或直接调用所获取的数据传输给用户。
进而,通过可配置的调用策略来配置接口被调用时所获取的数据,可以配置数据的缓存时间、缓存大小等,从而便于在接口不可用,或配置策略为获取预存数据时,将预先缓存的预存数据发送给用户,以便于用户接收到接口被调用的数据。
基于同一申请构思,参见图4所示,为本申请实施例提供的一种电子设备的结构示意图,电子设备20包括:处理器201、存储器202和总线203,所述存储器202存储有所述处理器201可执行的机器可读指令,当电子设备20运行时,所述处理器201与所述存储器202之间通过所述总线203进行通信,所述机器可读指令被所述处理器201运行时执行如上述实施例中任一所述的接口管理方法的步骤。
具体地,所述机器可读指令被所述处理器201执行时可以执行如下处理:响应于配置接口的请求操作,在所述接口管理界面上显示获取策略配置项和接口信息配置项,所述获取策略配置项用于配置在接口被调用时获取响应数据的策略,所述接口信息配置项用于配置策略对应的接口;响应于对所述获取策略配置项的选择操作,确定目标获取策略;响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口;将所述目标获取策略及对应的目标接口进行保存,以完成对目标接口及对应的目标获取策略的配置。
基于同一申请构思,本申请实施例还提供了一种计算机可读存储介质,所述计算机可读存储介质上存储有计算机程序,所述计算机程序被处理器运行时执行上述实施例提供的接口管理方法的步骤。
具体地,所述存储介质能够为通用的存储介质,如移动磁盘、硬盘等,所述存储介质上的计算机程序被运行时,能够执行上述接口管理方法,通过设置接口管理界面并预先配置好每个接口被调用时获取响应数据的策略,从而用户可以针对实际应用的情况对每个接口对应的策略进行配置,解决了现有技术中在后端服务器无法调用接口时导致的无法获取响应数据的技术问题,达到提高获取响应数据的效率的技术效果。
所属领域的技术人员可以清楚地了解到,为描述的方便和简洁,上述描述的系统和装置的具体工作过程,可以参考前述方法实施例中的对应过程,在此不再赘述。在本申请所提供的几个实施例中,应所述理解到,所揭露的系统、装置和方法,可以通过其它的方式实现。以上所描述的装置实施例仅仅是示意性的,例如,所述单元的划分,仅仅为一种逻辑功能划分,实际实现时可以有另外的划分方式,又例如,多个单元或组件可以结合或者可以集成到另一个系统,或一些特征可以忽略,或不执行。另一点,所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些通信接口,装置或单元的间接耦合或通信连接,可以是电性,机械或其它的形式。
所述作为分离部件说明的单元可以是或者也可以不是物理上分开的,作为单元显示的部件可以是或者也可以不是物理单元,即可以位于一个地方,或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。
另外,在本申请各个实施例中的各功能单元可以集成在一个处理单元中,也可以是各个单元单独物理存在,也可以两个或两个以上单元集成在一个单元中。
所述功能如果以软件功能单元的形式实现并作为独立的产品销售或使用时,可以存储在一个处理器可执行的非易失的计算机可读取存储介质中。基于这样的理解,本申请的技术方案本质上或者说对现有技术做出贡献的部分或者所述技术方案的部分可以以软件产品的形式体现出来,所述计算机软件产品存储在一个存储介质中,包括若干指令用以使得一台计算机设备(可以是个人计算机,服务器,或者网络设备等)执行本申请各个实施例所述方法的全部或部分步骤。而前述的存储介质包括:U盘、移动硬盘、只读存储器(Read-Only Memory,ROM)、随机存取存储器(Random Access Memory,RAM)、磁碟或者光盘等各种可以存储程序代码的介质。
以上仅为本申请的具体实施方式,但本申请的保护范围并不局限于此,任何熟悉本技术领域的技术人员在本申请揭露的技术范围内,可轻易想到变化或替换,都应涵盖在本申请的保护范围之内。因此,本申请的保护范围应以权利要求的保护范围为准。

Claims (9)

1.一种接口管理方法,其特征在于,通过前端设备提供接口管理界面,所述方法包括:
响应于配置接口的请求操作,在所述接口管理界面上显示获取策略配置项和接口信息配置项,所述获取策略配置项用于配置在接口被调用时获取响应数据的策略,所述接口信息配置项用于配置策略对应的接口;
响应于对所述获取策略配置项的选择操作,确定目标获取策略,所述获取策略配置项包括实时获取策略、预存数据获取策略和组合获取策略,所述目标获取策略为实时获取策略、预存数据获取策略和组合获取策略中的一个,其中,所述实时获取策略指的是在接口被调用时通过对应的后端服务器获取响应数据的获取策略,所述预存数据获取策略指的是在接口被调用时将对应的预存数据作为所获取的响应数据的获取策略,所述组合获取策略指的是在预设时间段内接口被调用时将对应的预存数据作为所获取的响应数据,以及在除预设时间段之外的接口被调用时通过对应的后端服务器获取响应数据的获取策略,所述预设时间段用于在后端服务器出现异常时,将预存数据作为响应数据,以防止影响开发进度;
响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口;
将所述目标获取策略及对应的目标接口进行保存,以完成对目标接口及对应的目标获取策略的配置;
在接口管理界面上设置通知推送,在后端服务器产生异常时,通过通知推送告知用户,以便于用户修改所述预设时间段。
2.根据权利要求1所述的方法,其特征在于,所述接口信息配置项包括服务配置项和接口配置项,所述响应于对所述接口信息配置项的选择操作,确定与所述目标获取策略对应的至少一个目标接口,包括:
响应于对所述服务配置项的选择操作,在至少一个预设服务中确定出目标服务,每个预设服务对应至少一个接口;
响应于对所述接口配置项的选择操作,在所述目标服务对应的至少一个接口中选择目标接口。
3.根据权利要求1所述的方法,其特征在于,所述方法还包括:
在确定所述目标获取策略为组合获取策略时,在所述接口管理界面上显示预设时间段配置项;
响应于对所述预设时间段配置项的配置指令,以对所述预设时间段进行配置。
4.根据权利要求1所述的方法,其特征在于,确定与所述目标获取策略对应的至少一个目标接口之后,所述方法还包括:
在所述接口管理界面上显示每个目标接口对应的预存数据列表,所述预存数据列表包括预先存储的目标接口的每条历史响应数据,每条历史响应数据对应修改项和确认项;
针对目标接口的每条历史响应数据,响应于对该历史响应数据的所述修改项的选择指令,以对该条历史响应数据进行修改;
针对目标接口的每条历史响应数据,响应于对该历史响应数据的所述确认项的选择指令,以在该目标接口的所述获取策略配置项为预存数据项且该目标接口被调用时,将该历史响应数据发送至所述前端设备进行显示。
5.根据权利要求1所述的方法,其特征在于,所述接口管理界面还包括策略列表和接口列表,所述方法还包括:
响应于对所述策略列表的选择指令,在所述接口管理界面中显示所述获取策略配置项中的每个获取策略及对应的操作项,获取策略对应的操作项用于指示用户对每个获取策略所执行的操作,响应于对每个获取策略的目标操作项的选择指令,以执行每个获取策略的目标操作,
和/或,
响应于对所述接口列表的选择指令,在所述接口管理界面中显示每个接口及对应的操作项,接口对应的操作项用于指示用户对每个接口所执行的操作,响应于对每个接口的目标操作项的选择指令,以执行每个接口的目标操作。
6.一种接口管理系统,其特征在于,所述接口管理系统包括前端设备和代理服务器,
其中,所述前端设备,用于显示接口管理界面;
所述代理服务器,用于执行如权利要求1-5任一项所述的接口管理方法。
7.根据权利要求6所述的系统,其特征在于,所述前端设备,还用于将用户针对待调用接口的调用指令发送至所述代理服务器;
所述代理服务器,还用于响应于所述调用指令,确定所述待调用接口对应的目标获取策略,依据所述目标获取策略,确定针对所述待调用接口的响应数据。
8.根据权利要求7所述的系统,其特征在于,所述接口管理系统还包括后端服务器,
其中,所述代理服务器,还用于在所述目标获取策略为实时获取策略时,将所述调用指令发送至后端服务器,在所述目标获取策略为组合获取策略时,在预设时间段之后将所述调用指令发送至后端服务器;
所述后端服务器,用于依据所述调用指令确定针对所述待调用接口的响应数据,将所述响应数据发送至所述代理服务器,以使所述代理服务器将所述响应数据发送至所述前端设备。
9.根据权利要求6所述的系统,其特征在于,所述接口管理系统还包括代码生成器和前端服务器,
所述前端设备,还用于将用户针对候选应用程序接口的应用程序接口文件发送至所述代码生成器;
所述代码生成器,还用于解析所述应用程序接口文件以生成所述候选应用程序接口对应的代码函数库,将代码函数库发送至前端服务器,以便于所述前端服务器应用所述代码函数库。
CN202410001121.1A 2024-01-02 2024-01-02 一种接口管理方法及接口管理系统 Active CN117519837B (zh)

Priority Applications (1)

Application Number Priority Date Filing Date Title
CN202410001121.1A CN117519837B (zh) 2024-01-02 2024-01-02 一种接口管理方法及接口管理系统

Applications Claiming Priority (1)

Application Number Priority Date Filing Date Title
CN202410001121.1A CN117519837B (zh) 2024-01-02 2024-01-02 一种接口管理方法及接口管理系统

Publications (2)

Publication Number Publication Date
CN117519837A CN117519837A (zh) 2024-02-06
CN117519837B true CN117519837B (zh) 2024-06-11

Family

ID=89757002

Family Applications (1)

Application Number Title Priority Date Filing Date
CN202410001121.1A Active CN117519837B (zh) 2024-01-02 2024-01-02 一种接口管理方法及接口管理系统

Country Status (1)

Country Link
CN (1) CN117519837B (zh)

Citations (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN108667916A (zh) * 2018-04-24 2018-10-16 百度在线网络技术(北京)有限公司 一种Web应用的数据访问方法及系统
CN110427181A (zh) * 2019-08-13 2019-11-08 山东浪潮商用系统有限公司 一种Web系统前后端分离方法
WO2020168567A1 (zh) * 2019-02-22 2020-08-27 深圳市欢太科技有限公司 数据处理方法、装置以及移动终端
CN112860308A (zh) * 2021-01-14 2021-05-28 网宿科技股份有限公司 接口定义的配置方法、业务处理方法、服务器及存储介质

Patent Citations (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN108667916A (zh) * 2018-04-24 2018-10-16 百度在线网络技术(北京)有限公司 一种Web应用的数据访问方法及系统
WO2020168567A1 (zh) * 2019-02-22 2020-08-27 深圳市欢太科技有限公司 数据处理方法、装置以及移动终端
CN110427181A (zh) * 2019-08-13 2019-11-08 山东浪潮商用系统有限公司 一种Web系统前后端分离方法
CN112860308A (zh) * 2021-01-14 2021-05-28 网宿科技股份有限公司 接口定义的配置方法、业务处理方法、服务器及存储介质

Also Published As

Publication number Publication date
CN117519837A (zh) 2024-02-06

Similar Documents

Publication Publication Date Title
CN110162512B (zh) 一种日志检索方法、装置及存储介质
US20150143355A1 (en) Service oriented architecture version and dependency control
JP4880376B2 (ja) 支援装置、プログラム、情報処理システム及び支援方法
CN109977012B (zh) 系统的联调测试方法、装置、设备及计算机可读存储介质
CN113360519B (zh) 数据处理方法、装置、设备和存储介质
CN111597110B (zh) 页面测试方法、装置、电子设备及存储介质
CN108111364B (zh) 一种业务系统的测试方法及装置
CN112765023A (zh) 测试用例生成方法、装置
JP6676564B2 (ja) 開発支援システムおよび方法
JP2012064129A (ja) 複数アプリケーションのgui統合方法
CN108959508B (zh) Sql数据生成方法及装置
CN109976725A (zh) 一种基于轻量级流程引擎的流程程序开发方法及装置
CN117519837B (zh) 一种接口管理方法及接口管理系统
CN112256999A (zh) 页面显示方法、装置、设备
CN110852050A (zh) 一种配置报表生成系统的方法、装置和电子设备
CN113032004A (zh) 在开发环境中管理开发作业的方法、设备和程序产品
US10061686B2 (en) Method, electronic apparatus, system, and storage medium for automated testing of application user interface
CN115794056A (zh) 脚本文件的处理方法、装置、设备及存储介质
US11675683B2 (en) Method, electronic device, and computer program product for monitoring storage system
CN114257652B (zh) 一种请求报文处理方法、装置、设备及可读存储介质
CN117235107B (zh) 数据访问处理方法、装置、电子设备及存储介质
CN113159583B (zh) 一种业务策略管理方法、装置和电子设备
CN112035425B (zh) 一种日志的存储方法、装置及计算机系统
CN117632309A (zh) 基于低代码框架的数据操作方法、装置、设备及介质
CN115357253A (zh) 一种软件产品部署方法、装置、设备及存储介质

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