CN109445841B - 接口文档管理方法、装置、服务器及存储介质 - Google Patents
接口文档管理方法、装置、服务器及存储介质 Download PDFInfo
- Publication number
- CN109445841B CN109445841B CN201811325321.3A CN201811325321A CN109445841B CN 109445841 B CN109445841 B CN 109445841B CN 201811325321 A CN201811325321 A CN 201811325321A CN 109445841 B CN109445841 B CN 109445841B
- Authority
- CN
- China
- Prior art keywords
- interface
- information
- system service
- document
- service
- 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
Links
Images
Classifications
-
- 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
Abstract
本发明实施例公开了一种接口文档管理方法、装置、服务器及存储介质。其中,该方法包括:向分布式服务中心订阅已注册的系统服务;接收所述分布式服务中心反馈的系统服务的地址信息;响应于接口文档构建指令,基于所述系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档。本发明实施例提供的技术方案,能够保证实际接口与接口文档的一致性,且实现了各系统服务之间接口文档的隔离。
Description
技术领域
本发明涉及计算机技术领域,尤其涉及一种接口文档管理方法、装置、服务器及存储介质。
背景技术
通常在一个项目开发完成后,开发人员会上传一份用于描述该项目中所有的接口属性的接口文档,以便其他开发人员能够通过接口文档清楚地了解相应的接口。
但是,由于各个团队所编写接口文档的格式不一致,在项目过程中,需要耗费比较多时间成本进行接口的沟通。另外,系统版本升级,接口改动,都需要及时更新接口文档,而现有的文档管理存在更新不及时,导致实际接口与接口文档不统一的现象。尤其是在某一系统具有多个系统服务,也就是说多个版本共用一个接口文档的场景下,还会出现多个系统服务接口信息相互干扰的情况。
发明内容
本发明实施例提供一种接口文档管理方法、装置、服务器及存储介质,能够保证实际接口与接口文档的一致性,且实现了各系统服务之间接口文档的隔离。
第一方面,本发明实施例提供了一种接口文档管理方法,应用于应用管理中心,该方法包括:
向分布式服务中心订阅已注册的系统服务;
接收所述分布式服务中心反馈的系统服务的地址信息;
响应于接口文档构建指令,基于所述系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档。
第二方面,本发明实施例还提供了一种接口文档管理装置,配置于应用管理中心,该装置包括:
订阅模块,用于向分布式服务中心订阅已注册的系统服务;
接收模块,用于接收所述分布式服务中心反馈的系统服务的地址信息;
接口文档构建模块,用于响应于接口文档构建指令,基于所述系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档。
第三方面,本发明实施例还提供了一种服务器,该服务器包括:
一个或多个处理器;
存储装置,用于存储一个或多个程序;
当所述一个或多个程序被所述一个或多个处理器执行,使得所述一个或多个处理器实现第一方面中任一所述的接口文档管理方法。
第四方面,本发明实施例还提供了一种存储介质,其上存储有计算机程序,该程序被处理器执行时实现第一方面中任一所述的接口文档管理方法。
本发明实施例提供的接口文档管理方法、装置、服务器及存储介质,在接收到接口文档构建指令后,应用管理中心基于分布式服务中心反馈的系统服务的地址信息,调用系统服务关联的第一接口函数获取该系统服务的接口信息,并依据获取的接口信息构建该系统服务的接口文档。相比于现有的接口文档管理方案,本方案在接收到接口文档构建指令后,依据实时获取的接口信息构建对应系统的接口文档,保证了实际接口与接口文档的一致性;同时通过调用系统服务关联的第一接口函数来获取该系统服务的接口信息,实现了各系统服务之间接口文档的隔离,同时实现了接口文档的自动化构建。
附图说明
通过阅读参照以下附图所作的对非限制性实施例所作的详细描述,本发明的其它特征、目的和优点将会变得更明显:
图1A是本发明实施例一中提供的一种接口文档管理方法的流程图;
图1B是本发明实施例一中提供的一种接口文档构建过程示意图;
图2是本发明实施例二中提供的一种接口文档管理方法的流程图;
图3是本发明实施例三中提供的一种接口文档管理装置的结构框图;
图4是本发明实施例四中提供的一种服务器的结构示意图。
具体实施方式
下面结合附图和实施例对本发明作进一步的详细说明。可以理解的是,此处所描述的具体实施例仅用于解释本发明,而非对本发明的限定。另外还需要说明的是,为了便于描述,附图中仅示出了与本发明相关的部分而非全部内容。
实施例一
图1A为本发明实施例一提供的一种接口文档管理方法的流程图,本实施例适用于如何对接口文档进行管理的情况,尤其适用于dubbo分布式服务系统下接口文档的管理,可应用于应用管理中心,如微信平台的管理中心(后台服务器),该应用管理中心能够聚合不同系统服务的接口信息。该方法可以由本发明实施例提供的接口文档管理装置来执行,该装置可采用软件和/或硬件的方式实现。参见图1A,该方法具体包括:
S110,向分布式服务中心订阅已注册的系统服务。
其中,分布式服务中心可以是一种维护或协调提供服务的系统及使用服务的应用管理中心(用户)之间关系的平台,如可以是一个能够为分布式应用提供协调服务及一致性服务的软件。由于ZooKeeper能够将简单易用的接口和性能高效、功能稳定的系统服务提供给应用管理中心,因此,本实施例中分布式服务中心可以是基于ZooKeeper构建的。
已注册的系统服务是指某一系统的某一个或多个系统服务上线时,向分布式服务中心所注册的服务,可以包括该系统服务的版本号、名称、服务类型、服务地址信息等。需要说明的是,一个系统可以部属多个系统服务,各系统服务的服务地址信息不同。本实施例中,系统服务为至少一个。
以分布式管理中心是ZooKeeper为例进行说明。参见图1B所示,API MNG即为应用管理中心,一个系统部署了三个系统服务分别为service A、service B、service C,在这三个系统上线时,该系统将向分布式服务中心注册自身所能提供的服务,也就是说,注册service A、service B、service C的相关信息;应用管理中心在启动或运行过程时,用户根据自身的需求,可以实时向分布式服务中心订阅已注册的系统服务,该系统服务可以包括service A、service B、service C中的至少一个。
S120,接收分布式服务中心反馈的系统服务的地址信息。
其中,地址信息是指能够定位或查询到某一系统服务的地址,例如可以是系统服务的IP端口(IP:Port)地址,还可以是该系统服务的物理地址等。
具体的,分布式管理中心接收到应用管理中心的订阅之后,获取该应用管理中心订阅的系统服务的地址信息,而后将地址信息以列表的形式反馈给该应用管理中心,应用管理中心接收分布式服务中心反馈的系统服务的地址信息。例如,可以参见图1B所示Zookeeper与API MNG之间的交互。
S130,响应于接口文档构建指令,基于系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档。
其中,接口文档构建指令可以是用于构建系统服务对应的接口文档时用户所触发的指令。可选的,接口文档构建指令中可以包括目标系统服务的地址信息。若接口文档构建指令中不包括目标系统服务的地址信息,应用管理中心则默认构建用户订阅的所有系统服务的接口文档。目标系统服务即为用户指定的已订阅系统服务中的至少一个。
可选的,应用管理中心在接收到分布式服务中心反馈的用户订阅的系统服务的地址信息后,可以基于各系统服务的地址信息为每个系统服务分配一个关联的按钮,该按钮专门用于触发对应的接口文档构建指令,可以是虚拟的物理按钮,还可以是基于地址信息构建的网页链接等。具体的,用户可以根据自身需求点击任意的一个或多个按钮触发相对应的系统服务的接口文档构建指令,此时,应用管理中心接收到的接口文档构建指令中包括目标统服务的地址信息。
本实施例中,第一接口函数是指每个系统服务向分布式管理中心注册服务时所注册的接口函数,应用管理中心通过调用任一系统服务的第一接口函数可获取到该系统服务的所有接口信息。可选的,第一接口函数可以是getAllApi函数。接口信息是指系统服务实现该服务所涉及的接口的声明信息,也可以说接口是用户调用某一系统服务中某一接口方法的入口。一个接口可以由一个服务名、方法名、IP端口地址以及其他dubbo服务等组成。可选的,接口信息可以包括接口名称、方法中的参数、参数注释以及接口注释等。其中,接口名称可以包括服务名和服务中的方法名等。示例性的,本实施例中,每个系统服务内部的接口采用汇编语言编写的注释函数进行注释说明。例如,可以采用Java在对应的接口方法及参数上编写注释函数如annotation函数对接口进行注释说明,而后通过对Java annotation函数解析得到对应的接口信息。因此,接口信息依据对汇编语言编写的注释函数解析得到。可选的,annotation函数内部可以采用自身的规范进行编写,也可以采用swagger-core规范进行编写。
接口文档是指用于清楚记载某一系统服务上所有接口信息的文档,可以是excel表、word或网页等的形式向用户展示。
具体的,若接口文档构建指令默认构建订阅的所有系统服务的接口文档,应用管理管理则依次或并发的调用每个系统服务关联的第一接口函数,基于第一接口函数对该系统服务中的注释函数(Java annotation函数)解析得到该系统服务关联的所有接口信息,而后依据获取的各系统服务的接口信息构建各系统关联的接口文档。
若应用管理中心接收到的接口文档构建指令中包括目标统服务的地址信息,应用管理中心则基于目标系统服务的地址信息,调用该目标系统服务关联的第一接口函数,基于第一接口函数对该系统服务中的注释函数(Java annotation函数)解析得到该系统服务关联的所有接口信息;并依据获取的接口信息构建该目标系统服务的接口文档。例如,参见图1B,若API MNG接收的接口文档构建指令包括service A的地址信息,API MNG将基于service A的地址信息调用service A的getAllApi函数,可以获取到service A的接口信息,而后基于service A的接口信息即可构建service A的接口文档。API MNG还可以同时构建service B与service C各自的接口文档。
需要说明的是,本实施例中,即使某一系统服务内部的接口调整和/或注释修改,用户在需要对该系统服务的接口文档进行管理时,可再次通过调用该系统服务关联的第一接口函数即可得到该系统服务实时修改或更新的接口信息,依据该接口信息对已构建的接口文档进行更新,保证了实际接口与接口文档的一致性。同时,本实施例中,基于每个系统服务各自关联的第一接口函数建立每个系统服务各自的接口文档,即一个系统上多个系统服务的接口分开管理,实现了各系统服务之间接口文档的隔离,避免出现多个系统服务的接口在一个接口文档中管理相互之间干扰的现象。
本发明实施例提供的接口文档管理方法,在接收到接口文档构建指令后,应用管理中心基于分布式服务中心反馈的系统服务的地址信息,调用系统服务关联的第一接口函数获取该系统服务的接口信息,并依据获取的接口信息构建该系统服务的接口文档。相比于现有的接口文档管理方案,本方案在接收到接口文档构建指令后,依据实时获取的接口信息构建对应系统的接口文档,保证了实际接口与接口文档的一致性;同时通过调用系统服务关联的第一接口函数来获取该系统服务的接口信息,实现了各系统服务之间接口文档的隔离,同时实现了接口文档的自动化构建。
本实施例中,若用户用于触发接口文档构建指令的按钮是基于地址信息构建的网页链接,应用管理中心在获取到该按钮关联的系统服务的接口信息后,可将该接口信息添加到网页链接关联的网页中,从而完成该系统服务接口文档的构建。示例性的,根据获取的接口信息构建接口文档之后,还可以包括:通过网页展示接口文档。将接口文档以网页的形式展示给用户,可便于用户浏览。
在上述实施例的基础上,本实施例提供了一种对已构建的接口文档进行更新的优选方案,具体的,基于系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档之后,还可以包括:若系统服务的接口调整和/或接口描述调整,且检测到接口文档更新指令,则调用系统服务关联的第一接口函数重新获取对应的接口信息;依据重新获取的接口信息更新接口文档。
其中,接口调整可以包括如下至少一种情况:某一接口的服务名改变、服务下的方法名改变或方法中的参数调整等。接口描述调整是指某一接口改变时,对应的接口注释函数的调整。接口文档更新指令可以与接口文档构建指令为同一触发操作所产生的指令,也可以不是。
需要说明的是,任一系统服务的接口调整和/或接口描述调整将导致该系统服务的接口信息发生改变,此时可以采用步骤S110至S130重新构建该系统服务关联的接口文档,还可以是已构建接口文档的更新。具体的,若系统服务的接口调整和/或接口描述调整,且检测到接口文档更新指令,则可以调用该系统服务关联的第一接口函数重新获取对应的接口信息;而后用户重新获取的接口信息替换之前的接口信息,进而更新该接口文档。
实施例二
图2为本发明实施例二提供的一种接口文档管理方法的流程图,本实施例在上述实施例的基础上进一步的优化。参见图2,该方法具体包括:
S210,向分布式服务中心订阅已注册的系统服务。
S220,接收分布式服务中心反馈的系统服务的地址信息。
S230,响应于接口文档构建指令,基于系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档。
S240,从接口文档中获取目标接口信息。
本实施例中,接口文档可以是应用管理中心已构建的所有文档,还可以是目标系统服务对应的接口文档。目标接口信息即为用户想要调用的某一系统服务中某一接口的信息。可选的,目标接口信息中可以包括目标系统服务的地址信息、目标接口名称、参数或接口注释等。
具体的,可以是用户想要调用某一系统服务中的某一接口时,可向应用管理中心发送包括调用目标接口的调用指令,例如用户触发应用管理中心中配置的调用按钮,应用管理中心响应用户的调用,从已构建的接口文档中选择目标系统服务,而后进入目标系统服务对应的接口文档获取目标接口信息。
还可以是用户进入某一系统服务的接口文档中进行浏览,到想要调用的目标接口位置处进行点击或触摸,应用管理中心检测到用户的相关操作,从该接口文档中获取目标接口信息,而后基于获取的目标接口信息直接执行该目标接口的调用操作即步骤S250。
S250,基于获取的目标接口信息,调用系统服务关联的第二接口函数获取对应的目标接口。
本实施例中,第二接口函数是指每个系统服务向分布式管理中心注册服务时所注册的接口函数,应用管理中心基于第一接口函数获取的接口信息构建的接口文档,通过调用任一系统服务的第二接口函数可获取或调用到该系统服务的具体接口。可选的,第二接口函数可以是invkoe函数。
具体的,应用管理中心可以基于获取的目标接口信息中的接口名称,调用该系统服务关联的第二接口函数,基于第二接口函数通过Java反射可以定位到该系统服务内目标接口信息对应的目标接口的位置,进而可获取到具体的目标接口的名称、参数、注释等,对该目标接口进行调用,即可实现目标接口对应的方法等。例如,参见图1B,若用户想到调用service A中的某一目标接口,则可以在该目标接口所在的接口文档中目标接口位置处进行点击或触摸,API MNG检测到用户的相关操作,从该接口文档中获取目标接口信息;而后API MNG基于获取的目标接口信息,调用service A的invoke函数,基于invoke函数通过Java反射可以定位到该系统服务内目标接口信息对应的目标接口的位置,进而可获取到具体的目标接口的名称、参数、注释等,对该目标接口进行调用,即可实现目标接口对应的方法等。
本发明实施例提供的接口文档管理方法,在接收到接口文档构建指令后,应用管理中心基于分布式服务中心反馈的系统服务的地址信息,调用系统服务关联的第一接口函数获取该系统服务的接口信息,并依据获取的接口信息构建该系统服务的接口文档;而后基于构建的接口文档,通过调用该系统服务关联的第二接口函数可以获取到对应的目标接口,进而对该目标接口进行调用,即可实现目标接口对应的方法。相比于现有的接口文档管理方案,本方案在接收到接口文档构建指令后,依据实时获取的接口信息构建对应系统的接口文档,保证了实际接口与接口文档的一致性;同时通过调用系统服务关联的第一接口函数来获取该系统服务的接口信息,实现了各系统服务之间接口文档的隔离,同时实现了接口文档的自动化构建。
实施例三
图3为本发明实施例三提供的一种接口文档管理装置的结构框图,该装置可配置于应用管理中心,该装置可执行本发明任意实施例所提供的接口文档管理方法,具备执行方法相应的功能模块和有益效果。如图3所示,该装置可以包括:
订阅模块310,用于向分布式服务中心订阅已注册的系统服务;
接收模块320,用于接收分布式服务中心反馈的系统服务的地址信息;
接口文档构建模块330,用于响应于接口文档构建指令,基于系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档。
本发明实施例提供的接口文档管理方法,在接收到接口文档构建指令后,应用管理中心基于分布式服务中心反馈的系统服务的地址信息,调用系统服务关联的第一接口函数获取该系统服务的接口信息,并依据获取的接口信息构建该系统服务的接口文档。相比于现有的接口文档管理方案,本方案在接收到接口文档构建指令后,依据实时获取的接口信息构建对应系统的接口文档,保证了实际接口与接口文档的一致性;同时通过调用系统服务关联的第一接口函数来获取该系统服务的接口信息,实现了各系统服务之间接口文档的隔离,同时实现了接口文档的自动化构建。
示例性的,上述装置还可以包括:
目标信息获取模块,用于基于系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档之后,从接口文档中获取目标接口信息;
接口获取模块,用于基于获取的目标接口信息,调用系统服务关联的第二接口函数获取对应的目标接口。
示例性的,接口信息依据对汇编语言编写的注解函数解析得到。
示例性的,上述装置还可以包括:
文档展示模块,用于根据获取的接口信息构建接口文档之后,还可以包括:通过网页展示接口文档。
示例性的,上述装置还可以包括:
接口文档更新模块,用于基于系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档之后,若系统服务的接口调整和/或接口描述调整,且检测到接口文档更新指令,则调用系统服务关联的第一接口函数重新获取对应的接口信息;依据重新获取的接口信息更新接口文档。
实施例四
图4为本发明实施例四提供的一种服务器的结构示意图。图4示出了适于用来实现本发明实施方式的示例性服务器12的框图。图4显示的服务器12仅仅是一个示例,不应对本发明实施例的功能和使用范围带来任何限制。
如图4所示,该服务器12以通用计算设备的形式表现。该服务器12的组件可以包括但不限于:一个或者多个处理器或者处理单元16,系统存储器28,连接不同系统组件(包括系统存储器28和处理单元16)的总线18。
总线18表示几类总线结构中的一种或多种,包括存储器总线或者存储器控制器,外围总线,图形加速端口,处理器或者使用多种总线结构中的任意总线结构的局域总线。举例来说,这些体系结构包括但不限于工业标准体系结构(ISA)总线,微通道体系结构(MAC)总线,增强型ISA总线、视频电子标准协会(VESA)局域总线以及外围组件互连(PCI)总线。
服务器12典型地包括多种计算机系统可读介质。这些介质可以是任何能够被服务器12访问的可用介质,包括易失性和非易失性介质,可移动的和不可移动的介质。
系统存储器28可以包括易失性存储器形式的计算机系统可读介质,例如随机存取存储器(RAM)30和/或高速缓存存储器32。服务器12可以进一步包括其它可移动/不可移动的、易失性/非易失性计算机系统存储介质。仅作为举例,存储系统34可以用于读写不可移动的、非易失性磁介质(图4未显示,通常称为“硬盘驱动器”)。尽管图4中未示出,可以提供用于对可移动非易失性磁盘(例如“软盘”)读写的磁盘驱动器,以及对可移动非易失性光盘(例如CD-ROM,DVD-ROM或者其它光介质)读写的光盘驱动器。在这些情况下,每个驱动器可以通过一个或者多个数据介质接口与总线18相连。系统存储器28可以包括至少一个程序产品,该程序产品具有一组(例如至少一个)程序模块,这些程序模块被配置以执行本发明各实施例的功能。
具有一组(至少一个)程序模块42的程序/实用工具40,可以存储在例如系统存储器28中,这样的程序模块42包括但不限于操作系统、一个或者多个应用程序、其它程序模块以及程序数据,这些示例中的每一个或某种组合中可能包括网络环境的实现。程序模块42通常执行本发明所描述的实施例中的功能和/或方法。
服务器12也可以与一个或多个外部设备14(例如键盘、指向设备、显示器24等)通信,还可与一个或者多个使得用户能与该设备交互的设备通信,和/或与使得该服务器12能与一个或多个其它计算设备进行通信的任何设备(例如网卡,调制解调器等等)通信。这种通信可以通过输入/输出(I/O)接口22进行。并且,服务器12还可以通过网络适配器20与一个或者多个网络(例如局域网(LAN),广域网(WAN)和/或公共网络,例如因特网)通信。如图所示,网络适配器20通过总线18与服务器12的其它模块通信。应当明白,尽管图中未示出,可以结合服务器12使用其它硬件和/或软件模块,包括但不限于:微代码、设备驱动器、冗余处理单元、外部磁盘驱动阵列、RAID系统、磁带驱动器以及数据备份存储系统等。
处理单元16通过运行存储在系统存储器28中的程序,从而执行各种功能应用以及数据处理,例如实现本发明实施例所提供的接口文档管理方法。
实施例五
本发明实施例五还提供了一种计算机可读存储介质,其上存储有计算机程序,该程序被处理器执行时可实现上述实施例中任一所述的接口文档管理方法。
本发明实施例的计算机存储介质,可以采用一个或多个计算机可读的介质的任意组合。计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质。计算机可读存储介质例如可以是但不限于:电、磁、光、电磁、红外线、或半导体的系统、装置或器件,或者任意以上的组合。计算机可读存储介质的更具体的例子(非穷举的列表)包括:具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机存取存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本文件中,计算机可读存储介质可以是任何包含或存储程序的有形介质,该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。
计算机可读的信号介质可以包括在基带中或者作为载波一部分传播的数据信号,其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式,包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读的信号介质还可以是计算机可读存储介质以外的任何计算机可读介质,该计算机可读介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。
计算机可读介质上包含的程序代码可以用任何适当的介质传输,包括但不限于:无线、电线、光缆、RF等等,或者上述的任意合适的组合。
可以以一种或多种程序设计语言或其组合来编写用于执行本发明操作的计算机程序代码,所述程序设计语言包括面向对象的程序设计语言—诸如Java、Smalltalk、C++,还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中,远程计算机可以通过任意种类的网络包括局域网(LAN)或广域网(WAN)连接到用户计算机,或者,可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。
上述实施例序号仅仅为了描述,不代表实施例的优劣。
本领域普通技术人员应该明白,上述的本发明的各模块或各步骤可以用通用的计算装置来实现,它们可以集中在单个计算装置上,或者分布在多个计算装置所组成的网络上,可选地,他们可以用计算机装置可执行的程序代码来实现,从而可以将它们存储在存储装置中由计算装置来执行,或者将它们分别制作成各个集成电路模块,或者将它们中的多个模块或步骤制作成单个集成电路模块来实现。这样,本发明不限制于任何特定的硬件和软件的结合。
本说明书中的各个实施例均采用递进的方式描述,每个实施例重点说明的都是与其他实施例的不同之处,各个实施例之间的相同或相似的部分互相参见即可。
以上所述仅为本发明的优选实施例,并不用于限制本发明,对于本领域技术人员而言,本发明可以有各种改动和变化。凡在本发明的精神和原理之内所作的任何修改、等同替换、改进等,均应包含在本发明的保护范围之内。
Claims (8)
1.一种接口文档管理方法,其特征在于,应用于应用管理中心,所述方法包括:
向分布式服务中心订阅已注册的系统服务;
接收所述分布式服务中心反馈的系统服务的地址信息;
响应于接口文档构建指令,基于所述系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档;
基于所述系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档之后,所述方法还包括:
从所述接口文档中获取目标接口信息;
基于获取的目标接口信息,调用系统服务关联的第二接口函数获取对应的目标接口。
2.根据权利要求1所述的方法,其特征在于,所述接口信息依据对汇编语言编写的注释函数解析得到。
3.根据权利要求1所述的方法,其特征在于,根据获取的接口信息构建接口文档之后,还包括:
通过网页展示所述接口文档。
4.根据权利要求1所述的方法,其特征在于,基于所述系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档之后,还包括:
若系统服务的接口调整和/或接口描述调整,且检测到接口文档更新指令,则调用所述系统服务关联的第一接口函数重新获取对应的接口信息;
依据重新获取的接口信息更新所述接口文档。
5.一种接口文档管理装置,其特征在于,配置于应用管理中心,所述装置包括:
订阅模块,用于向分布式服务中心订阅已注册的系统服务;
接收模块,用于接收所述分布式服务中心反馈的系统服务的地址信息;
接口文档构建模块,用于响应于接口文档构建指令,基于所述系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档;
所述装置还包括:
目标信息获取模块,用于基于所述系统服务的地址信息,调用系统服务关联的第一接口函数获取对应的接口信息,并根据获取的接口信息构建接口文档之后,从所述接口文档中获取目标接口信息;
接口获取模块,用于基于获取的目标接口信息,调用系统服务关联的第二接口函数获取对应的目标接口。
6.根据权利要求5所述的装置,其特征在于,所述接口信息依据对汇编语言编写的注解函数解析得到。
7.一种服务器,其特征在于,所述服务器包括:
一个或多个处理器;
存储装置,用于存储一个或多个程序;
当所述一个或多个程序被所述一个或多个处理器执行,使得所述一个或多个处理器实现如权利要求1-4中任一所述的接口文档管理方法。
8.一种存储介质,其上存储有计算机程序,其特征在于,该程序被处理器执行时实现如权利要求1-4中任一所述的接口文档管理方法。
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN201811325321.3A CN109445841B (zh) | 2018-11-08 | 2018-11-08 | 接口文档管理方法、装置、服务器及存储介质 |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN201811325321.3A CN109445841B (zh) | 2018-11-08 | 2018-11-08 | 接口文档管理方法、装置、服务器及存储介质 |
Publications (2)
Publication Number | Publication Date |
---|---|
CN109445841A CN109445841A (zh) | 2019-03-08 |
CN109445841B true CN109445841B (zh) | 2022-04-22 |
Family
ID=65551456
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
CN201811325321.3A Active CN109445841B (zh) | 2018-11-08 | 2018-11-08 | 接口文档管理方法、装置、服务器及存储介质 |
Country Status (1)
Country | Link |
---|---|
CN (1) | CN109445841B (zh) |
Families Citing this family (5)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN110244952A (zh) * | 2019-05-09 | 2019-09-17 | 恩亿科(北京)数据科技有限公司 | 应用程序编程接口文档的管理方法和计算机可读存储介质 |
CN111258627B (zh) * | 2020-01-14 | 2023-04-25 | 中国建设银行股份有限公司 | 一种接口文档生成方法和装置 |
CN112583891B (zh) * | 2020-11-19 | 2021-07-06 | 联通智网科技有限公司 | 接口文档获取方法、装置和服务器 |
CN113485746B (zh) * | 2021-07-28 | 2024-02-06 | 山石网科通信技术股份有限公司 | 应用程序接口文档的生成方法及装置 |
CN113641355A (zh) * | 2021-08-11 | 2021-11-12 | 杭州安恒信息技术股份有限公司 | 一种接口文档生成方法、系统及存储介质 |
Citations (5)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN104601403A (zh) * | 2015-01-07 | 2015-05-06 | 上海瀚之友信息技术服务有限公司 | 一种自动化测试系统 |
CN105450757A (zh) * | 2015-12-02 | 2016-03-30 | 联动优势电子商务有限公司 | 一种服务管理方法及系统 |
CN107046482A (zh) * | 2017-04-25 | 2017-08-15 | 厦门集微科技有限公司 | 一种api服务的管理方法及装置 |
CN108255714A (zh) * | 2018-01-02 | 2018-07-06 | 深圳壹账通智能科技有限公司 | 接口文档构建测试方法及终端设备 |
CN108762808A (zh) * | 2018-05-17 | 2018-11-06 | 李伟荣 | 接口文档的生成方法及系统 |
-
2018
- 2018-11-08 CN CN201811325321.3A patent/CN109445841B/zh active Active
Patent Citations (5)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN104601403A (zh) * | 2015-01-07 | 2015-05-06 | 上海瀚之友信息技术服务有限公司 | 一种自动化测试系统 |
CN105450757A (zh) * | 2015-12-02 | 2016-03-30 | 联动优势电子商务有限公司 | 一种服务管理方法及系统 |
CN107046482A (zh) * | 2017-04-25 | 2017-08-15 | 厦门集微科技有限公司 | 一种api服务的管理方法及装置 |
CN108255714A (zh) * | 2018-01-02 | 2018-07-06 | 深圳壹账通智能科技有限公司 | 接口文档构建测试方法及终端设备 |
CN108762808A (zh) * | 2018-05-17 | 2018-11-06 | 李伟荣 | 接口文档的生成方法及系统 |
Also Published As
Publication number | Publication date |
---|---|
CN109445841A (zh) | 2019-03-08 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
CN109445841B (zh) | 接口文档管理方法、装置、服务器及存储介质 | |
CN113110941B (zh) | 使用应用容器管理代码和依赖性数据的传递 | |
CN109032706B (zh) | 智能合约执行方法、装置、设备和存储介质 | |
CN110597595B (zh) | 多语言信息的提供方法、配置方法、装置、设备和介质 | |
CN109634490B (zh) | 一种列表显示方法、装置、设备及存储介质 | |
US20190102201A1 (en) | Component invoking method and apparatus, and component data processing method and apparatus | |
CN109062563B (zh) | 用于生成页面的方法和装置 | |
US8433687B1 (en) | Off-line indexing for client-based software development tools | |
US20080222617A1 (en) | Server side application integration framework | |
CN111309216B (zh) | 列表页面的显示方法、装置、计算机设备及存储介质 | |
US11966795B2 (en) | Method and device for loading minus-one screen, terminal, and computer readable storage medium | |
US20140156726A1 (en) | Representational State Transfer Communications via Remote Function Calls | |
CN110619100B (zh) | 用于获取数据的方法和装置 | |
US20200356469A1 (en) | Test automation systems and methods using logical identifiers | |
US11288170B1 (en) | Log analysis debugging without running on real production environment | |
CN114048415A (zh) | 表单生成方法及装置、电子设备和计算机可读存储介质 | |
US20140089909A1 (en) | Dynamically building locale objects at run-time | |
CN110807535A (zh) | 统一预约平台的构建方法、构建装置和统一预约平台系统 | |
US11256501B2 (en) | Federated extensibility workbench | |
CN113127430A (zh) | 镜像信息处理方法、装置、计算机可读介质及电子设备 | |
US10275264B1 (en) | Configuration management of remote sources using activator fields | |
CN116360735A (zh) | 一种表单生成方法、装置、设备和介质 | |
CN111290818B (zh) | 创建应用程序的操作方法及应用程序的操作方法 | |
CN114461223A (zh) | 一种代码生成方法、装置及终端设备 | |
CN110377401B (zh) | 基于idea的事务请求处理方法、装置、服务器和存储介质 |
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 |