CN110795147A

CN110795147A - 一种接口协议文件管理方法和装置

Info

Publication number: CN110795147A
Application number: CN201810864313.XA
Authority: CN
Inventors: 江龙飞
Original assignee: Beijing Jingdong Century Trading Co Ltd; Beijing Jingdong Shangke Information Technology Co Ltd
Current assignee: Beijing Jingdong Century Trading Co Ltd; Beijing Jingdong Shangke Information Technology Co Ltd
Priority date: 2018-08-01
Filing date: 2018-08-01
Publication date: 2020-02-14

Abstract

本发明公开了一种接口协议文件管理方法和装置，涉及计算机技术领域。该方法的一具体实施方式包括：接收对目标接口的开发指令，获取目标接口在开发过程中的最新接口信息；当存在与目标接口相应的协议文件时，根据与目标接口相应的协议规则以及最新接口信息，更新协议文件。该实施方式利用开发工具自定义插件技术，在开发业务接口的同时，就可以利用此插件，按照既定协议规则、自动生成/更新协议文件，并保存在当前项目的资源文件路径中，进而可视化编辑整个协议文件，同时便于后期动态修改、维护，降低现有因手动修改的错误率。

Description

一种接口协议文件管理方法和装置

技术领域

本发明涉及计算机技术领域，尤其涉及一种接口协议文件管理方法和装置。

背景技术

随着移动应用与企业间互联需求的兴起，越来越多的企业选择将自身的业务进行对外开放。

为综合管理这些开放性业务，需要统一的API(Application ProgrammingInterface，应用程序编程接口)网关系统来进行集中管理。企业内部业务对外发布时，需要依赖协议文件描述业务接口信息，然后结合业务接口，导入API网关系统中进行发布。

现有系统中的协议文件，通常是通过应用自动生成工具/代码一次性生成。但在实现本发明的过程中，发明人发现现有技术至少存在如下问题：

1)对于已生成的协议文件，会经常因为业务的变更需要进行修改，但由于协议文件是通过生成工具一次性生成，需要线下对协议文件做手动修改，修改后的内容依赖工具再生成文件，然后替换掉原协议文件；

2)目前协议文件描述较为复杂，开发人员编写/修改这些协议文件很容易出错、且效率较低。

发明内容

有鉴于此，本发明实施例提供一种接口协议文件管理方法和装置，至少能够解决现有技术中协议文件只能一次性生成，且不支持动态修改的问题。

为实现上述目的，根据本发明实施例的一个方面，提供了一种接口协议文件管理方法，包括：

接收对目标接口的开发指令，获取所述目标接口在开发过程中的最新接口信息；

当存在与所述目标接口相应的协议文件时，根据与所述目标接口相应的协议规则以及所述最新接口信息，更新所述协议文件。

可选的，在更新所述协议文件之后，还包括：

根据软件版本与软件开发包的对应关系，转换更新后的协议文件为相应软件版本的软件开发包；

接收客户端传输的软件开发包调用请求，提取与所述客户端的软件版本相应的软件开发包并传输至所述客户端。

可选的，在更新所述协议文件之后，还包括：根据网关系统中的预定文档生成规则，生成与更新后的协议文件相应的网关文档。

可选的，接口信息至少包括接口名、方法名、入参、出参以及异常信息；所述协议规则至少包括接口节点、方法节点、入参属性节点、出参节点以及异常信息节点。

为实现上述目的，根据本发明实施例的另一方面，提供了一种接口协议文件管理装置，包括：

接口信息获取模块，用于接收对目标接口的开发指令，获取所述目标接口在开发过程中的最新接口信息；

协议文件更新模块，用于当存在与所述目标接口相应的协议文件时，根据与所述目标接口相应的协议规则以及所述最新接口信息，更新所述协议文件。

可选的，还包括软件开发包生成模块，用于：

可选的，还包括网关文档生成模块，用于：根据网关系统中的预定文档生成规则，生成与更新后的协议文件相应的网关文档。

为实现上述目的，根据本发明实施例的再一方面，提供了一种接口协议文件管理电子设备。

本发明实施例的电子设备包括：一个或多个处理器；存储装置，用于存储一个或多个程序，当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现上述任一所述的接口协议文件管理方法。

为实现上述目的，根据本发明实施例的再一方面，提供了一种计算机可读介质，其上存储有计算机程序，所述程序被处理器执行时实现上述任一所述的接口协议文件管理方法。

根据本发明所述提供的方案，上述发明中的一个实施例具有如下优点或有益效果：利用开发工具Idea自定义插件技术，用户在开发接口的同时，就可以利用此插件，按照既定协议规则、自动生成协议文件，保存在当前项目的资源文件路径中，进而可视化编辑整个协议文件，并支持动态修改协议文件内容。

上述的非惯用的可选方式所具有的进一步效果将在下文中结合具体实施方式加以说明。

附图说明

附图用于更好地理解本发明，不构成对本发明的不当限定。其中：

图1是根据本发明实施例的一种接口协议文件管理方法的主要流程示意图；

图2是本发明实施例提供的整体流程示意图；

图3是根据本发明实施例的一种接口协议文件管理装置的主要模块示意图；

图4是本发明实施例可以应用于其中的示例性系统架构图；

图5是适于用来实现本发明实施例的移动设备或服务器的计算机系统的结构示意图。

具体实施方式

以下结合附图对本发明的示范性实施例做出说明，其中包括本发明实施例的各种细节以助于理解，应当将它们认为仅仅是示范性的。因此，本领域普通技术人员应当认识到，可以对这里描述的实施例做出各种改变和修改，而不会背离本发明的范围和精神。同样，为了清楚和简明，以下的描述中省略了对公知功能和结构的描述。

对于本发明所涉及的词语，做解释如下：

Idea：代码开发工具。

XML(Extensible Markup Language)：可扩展标记语言，标准通用标记语言的子集，是一种用于标记电子文件使其具有结构性的标记语言。

TXT：文本文档。

DOM(Document Object Model)：文档对象模型，是W3C组织推荐的处理可扩展标志语言的标准编程接口。

参见图1，示出的是本发明实施例提供的一种接口协议文件管理方法的主要流程图，包括如下步骤：

S101：接收对目标接口的开发指令，获取所述目标接口在开发过程中的最新接口信息；

S102：当存在与所述目标接口相应的协议文件时，根据与所述目标接口相应的协议规则以及所述最新接口信息，更新所述协议文件。

对于开放性业务接口，其接口信息通常依赖于协议文件进行描述，并存储于网关系统中进行发布，供调用者(例如，用户、客户端或其他应用)调用。

上述实施方式中，对于步骤S101，接口信息，通常是在业务接口开发完成之后获取，也可以是开发过程中获取，通常情况下，开发完成后的接口信息更为全面，因为通常选择开发完成之后获取。

对于接口信息，可以是与业务接口相应的所有描述信息；也可以是依据工作人员选择哪些需要获取、哪些不需要，例如，接口名、方法名、入参、出参、异常信息。

另外，也可以根据所要获取的接口信息类型等，生成相应的请求，以在业务接口的开发过程中，Idea插件根据该请求，利用自定义插件，仅获取这些类型的接口信息即可。

对于步骤S102，基于最新接口信息，更新业务接口的协议文件。

协议文件还需要依赖协议规则所生成/更新，而该协议规则的设定又依赖于协议文件所存储的网关系统。

协议规则，主要是用于定义网关系统协议的文件生成模板。为便于管理，可以针对所有网关系统，设置一样的协议规则；也可以针对不同的网关系统，相应分别设置适合于各自网关系统的协议规则。

所生成的协议文件，其格式针对不同的网关系统可以有多种，例如XML、TXT等。相应协议规则包括多个节点，分别针对于接口信息的接口名、方法名、入参、出参以及异常信息等。

以XML为例，将XML中每一层DOM节点的属性定义为模板，得到协议规则，例如：

1)接口节点，包括接口名、接口别名、接口描述等信息；

2)方法节点，包括方法名、方法描述、是否需要授权等信息；

3)入参属性节点，包括参数名、参数类型、默认值等信息；

4)出参属性节点，包括返回值的类型、默认值等信息；

5)异常信息节点，包括接口返回的异常描述信息。

另外，这几个节点中，接口节点可以包括方法节点，而方法节点又可以包括剩余入参属性节点、返回值节点以及异常信息节点。

所生成的协议文件，通常存储于业务接口的资源文件中，例如API网关系统中，其具体生成流程，具体参见图2所示。

当该业务接口有新的开发指令时，需要获取其在新的开发过程中的最新接口信息，并基于最新接口信息对历史所生成的协议文件做动态修改。

对于历史协议文件的动态修改，通常需要先将最新接口信息中的参数实体(例如，入参、出参的报文数据)做解析，并和现有协议文件进行比对，对于比对所得不同之处，之后基于最新接口信息，替换掉原文件中所需更改的内容，以实现动态更新。

本发明实施例中，网关系统提供有导入功能，便于对协议文件的导入。当有协议文件生成时，可以动态导入；也可以由工作人员选定所需导入的协议文件(例如，接口开发过程中出现bug，那么相应的协议文件可以不需要)，通过该导入功能导入到网关系统中。

网关系统对于导入后的协议文件管理，可以有多种方式：

1)若该业务接口初次开发，不存在历史协议文件，则直接基于接口信息生成协议文件，并添加至网关系统中；

2)若该业务接口非初次开发，是存在历史协议文件的：

①协议文件累加：直接将当前所生成的协议文件，添加至该业务接口的协议文件组中；例如，协议文件_2018.07.01、协议文件_2018.07.02；

②协议文件更替：仅保留当前所生成协议文件，或者是生成日期最新的协议文件；例如协议文件_2018.07.01；

③协议文件内容的累加：针对该业务接口，仍是只保留一个协议文件，但该协议文件中保存有历史与当前最新的接口信息。例如，历史信息为3字段，本次信息为5字段，最终所得到的协议文件包含该3字段以及5字段的信息。

对于协议文件的具体处理方式，具体依据工作人员设定。

本发明实施例中，在生成协议文件之后，还可以根据定制的模板，例如，SDK(Software Development Kit，软件开发工具包)工具模块，自动生成相应版本的SDK包，供不同版本的客户端调用，提高应用范围。

这里的SDK工具模块，可以是JAVA SDK模块、.NET SDK模块、Python SDK模块等，因此，所生成的SDK包可以分别应应用于JAVA版本、.NET版本、Python版本。

本发明实施例中，同样在生成协议文件之后，可以根据网关系统中的文档模板，例如API文档模板，生成API文档，用于描述业务接口的入参、出参等信息。这里的文档模板，可以是工作人员根据需要选择/设定的，比如网关系统1-文档模板1。

另外，也可以根据业务接口在开发过程中的实际开发数据，结合该API文档，生成相应的API调用示例，便于后续调用使用，类似于自动化测试示例。

上述实施例所提供的方法，利用开发工具Idea自定义插件技术，在开发业务接口时，就可以根据既定的协议规则，自动生成协议文件；并依据接口最新开发的信息，自动更新协议文件，避免出现现有手动更改文件的错误情况，便于后续文件维护。

参见图3，示出了本发明实施例提供的一种接口协议文件管理装置300的主要模块示意图，包括：

接口信息获取模块301，用于接收对目标接口的开发指令，获取所述目标接口在开发过程中的最新接口信息；

协议文件更新模块302，用于当存在与所述目标接口相应的协议文件时，根据与所述目标接口相应的协议规则以及所述最新接口信息，更新所述协议文件。

本发明实施装置还包括软件开发包生成模块303(图中未标出)，用于：

本发明实施装置还包括网关文档生成模块304(图中未标出)，用于：根据网关系统中的预定文档生成规则，生成与更新后的协议文件相应的网关文档。

本发明实施装置中，接口信息至少包括接口名、方法名、入参、出参以及异常信息；所述协议规则至少包括接口节点、方法节点、入参属性节点、出参节点以及异常信息节点。

另外，在本发明实施例中所述的接口协议文件管理装置的具体实施内容，在上面所述接口协议文件管理方法中已经详细说明了，故在此重复内容不再说明。

本法实施例所提供的装置，利用开发工具Idea自定义插件技术，用户在开发接口之后，就可以利用此插件，按照既定协议规则、自动生成协议文件，保存在当前项目的资源文件路径中，进而可视化编辑整个协议文件，并支持动态修改协议文件内容，减少了手动更改的错误情况。

图4示出了可以应用本发明实施例的接口协议文件管理方法或接口协议文件管理装置的示例性系统架构400。

如图4所示，系统架构400可以包括终端设备401、402、403，网络404和服务器405(仅仅是示例)。网络404用以在终端设备401、402、403和服务器405之间提供通信链路的介质。网络404可以包括各种连接类型，例如有线、无线通信链路或者光纤电缆等等。

用户可以使用终端设备401、402、403通过网络404与服务器405交互，以接收或发送消息等。终端设备401、402、403上可以安装有各种通讯客户端应用，例如购物类应用、网页浏览器应用、搜索类应用、即时通信工具、邮箱客户端、社交平台软件等(仅为示例)。

终端设备401、402、403可以是具有显示屏并且支持网页浏览的各种电子设备，包括但不限于智能手机、平板电脑、膝上型便携计算机和台式计算机等等。

服务器405可以是提供各种服务的服务器，例如对用户利用终端设备401、402、403所浏览的购物类网站提供支持的后台管理服务器(仅为示例)。后台管理服务器可以对接收到的产品信息查询请求等数据进行分析等处理，并将处理结果(例如目标推送信息、产品信息--仅为示例)反馈给终端设备。

需要说明的是，本发明实施例所提供的接口协议文件管理方法一般由服务器405执行，相应地，接口协议文件管理装置一般设置于服务器405中。

应该理解，图4中的终端设备、网络和服务器的数目仅仅是示意性的。根据实现需要，可以具有任意数目的终端设备、网络和服务器。

下面参考图5，其示出了适于用来实现本发明实施例的终端设备的计算机系统500的结构示意图。图5示出的终端设备仅仅是一个示例，不应对本发明实施例的功能和使用范围带来任何限制。

如图5所示，计算机系统500包括中央处理单元(CPU)501，其可以根据存储在只读存储器(ROM)502中的程序或者从存储部分508加载到随机访问存储器(RAM)503中的程序而执行各种适当的动作和处理。在RAM 503中，还存储有系统500操作所需的各种程序和数据。CPU 501、ROM 502以及RAM 503通过总线504彼此相连。输入/输出(I/O)接口505也连接至总线504。

以下部件连接至I/O接口505：包括键盘、鼠标等的输入部分506；包括诸如阴极射线管(CRT)、液晶显示器(LCD)等以及扬声器等的输出部分507；包括硬盘等的存储部分508；以及包括诸如LAN卡、调制解调器等的网络接口卡的通信部分509。通信部分509经由诸如因特网的网络执行通信处理。驱动器510也根据需要连接至I/O接口505。可拆卸介质511，诸如磁盘、光盘、磁光盘、半导体存储器等等，根据需要安装在驱动器510上，以便于从其上读出的计算机程序根据需要被安装入存储部分508。

特别地，根据本发明公开的实施例，上文参考流程图描述的过程可以被实现为计算机软件程序。例如，本发明公开的实施例包括一种计算机程序产品，其包括承载在计算机可读介质上的计算机程序，该计算机程序包含用于执行流程图所示的方法的程序代码。在这样的实施例中，该计算机程序可以通过通信部分509从网络上被下载和安装，和/或从可拆卸介质511被安装。在该计算机程序被中央处理单元(CPU)501执行时，执行本发明的系统中限定的上述功能。

需要说明的是，本发明所示的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本发明中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本发明中，计算机可读的信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读的信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：无线、电线、光缆、RF等等，或者上述的任意合适的组合。

附图中的流程图和框图，图示了按照本发明各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，上述模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图或流程图中的每个方框、以及框图或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

描述于本发明实施例中所涉及到的模块可以通过软件的方式实现，也可以通过硬件的方式来实现。所描述的模块也可以设置在处理器中，例如，可以描述为：一种处理器包括接口信息获取模块、协议文件更新模块。其中，这些模块的名称在某种情况下并不构成对该模块本身的限定，例如，协议文件更新模块还可以被描述为“基于最新接口信息的协议文件更新模块”。

作为另一方面，本发明还提供了一种计算机可读介质，该计算机可读介质可以是上述实施例中描述的设备中所包含的；也可以是单独存在，而未装配入该设备中。上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被一个该设备执行时，使得该设备包括：

根据本发明实施例的技术方案，利用开发工具Idea自定义插件技术，用户在开发接口之后，就可以利用此插件，按照既定协议规则、自动生成协议文件，保存在当前项目的资源文件路径中，进而可视化编辑整个协议文件，并支持动态修改协议文件内容。

上述具体实施方式，并不构成对本发明保护范围的限制。本领域技术人员应该明白的是，取决于设计要求和其他因素，可以发生各种各样的修改、组合、子组合和替代。任何在本发明的精神和原则之内所作的修改、等同替换和改进等，均应包含在本发明保护范围之内。

Claims

1.一种接口协议文件管理方法，其特征在于，包括：

2.根据权利要求1所述的方法，其特征在于，在更新所述协议文件之后，还包括：

3.根据权利要求1所述的方法，其特征在于，在更新所述协议文件之后，还包括：

根据网关系统中的预定文档生成规则，生成与更新后的协议文件相应的网关文档。

4.根据权利要求1所述的方法，其特征在于，接口信息至少包括接口名、方法名、入参、出参以及异常信息；所述协议规则至少包括接口节点、方法节点、入参属性节点、出参节点以及异常信息节点。

5.一种接口协议文件管理装置，其特征在于，包括：

6.根据权利要求5所述的装置，其特征在于，还包括软件开发包生成模块，用于：

7.根据权利要求5所述的装置，其特征在于，还包括网关文档生成模块，用于：

8.根据权利要求5所述的装置，其特征在于，接口信息至少包括接口名、方法名、入参、出参以及异常信息；所述协议规则至少包括接口节点、方法节点、入参属性节点、出参节点以及异常信息节点。

9.一种电子设备，其特征在于，包括：

一个或多个处理器；

存储装置，用于存储一个或多个程序，

当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现如权利要求1-4中任一所述的方法。

10.一种计算机可读介质，其上存储有计算机程序，其特征在于，所述程序被处理器执行时实现如权利要求1-4中任一所述的方法。