CN110333897A - 一种接口配置方法、装置、介质和电子设备 - Google Patents

Abstract

本发明提供了一种接口配置方法、装置、介质和电子设备，方法包括：获取接口文档；对请求参数执行json解析；基于解析结果对所述接口进行配置。使用API自动生成通用接口组件以后，后端开发人员无需人工维护接口文档，只需要启动项目，前端工程师就可以直接访问对应的接口地址，即可获取到最新接口的方法入参、出参、参数类型、接口描述等信息，也可以直接填入测试数据发送请求获取接口返回数据。

Description

一种接口配置方法、装置、介质和电子设备

技术领域

本发明涉及计算机技术领域，具体而言，涉及一种接口配置方法、装置、介质和电子设备。

背景技术

在前后端分离开发应用的过程中，为前端开发人员提供可靠的开发文档是非常有必要的。经常会遇到接口返回结果会因为产品的迭代发生变更，一般接口文档都是人工来维护，可能由于人员变动导致接口文档更新滞后或者接口文档与接口返回结果不一致等等问题。

公开内容

本发明的目的在于提供一种接口配置方法、装置、介质和电子设备，能够解决上述提到的至少一个技术问题。具体方案如下：

根据本发明的具体实施方式，第一方面，本发明提供一种接口配置方法，应用于SpringMVC框架，其特征在于，包括：

获取接口文档，；

对请求参数执行json解析；

基于解析结果对所述接口进行配置。

可选的，所述获取接口文档后，还需要对所述接口文档进行注释。

可选的，所述对请求参数执行json解析具体包括：

将json数据自动解析并填充到请求参数表单。

可选的，所述方法还包括：

对所述接口进行测试；

基于测试结果进行操作。

可选的，所述基于测试结果进行操作包括：

若测试成功，通过cook i e进行参数记忆。

可选的，所述基于测试结果进行操作还包括：

对于请求过的接口，自动填写输入过的值。

可选的，所述获取接口文档，对所述接口文档进行注释之后，包括：

添加pom依赖；

添加接口控制器到spring配置文件.

可选的，所述接口文档包括：

接口名称、参数名称、参数类型、参数描述。

可选的，所述对所述接口进行测试，使所述接口满足预定功能需求，包括：

在接口测试表达添加表单扩展字段，提交测试后将所述扩展字段传到后台。

根据本发明的具体实施方式，第二方面，本发明提供一种接口配置装置，应用于SpringMVC框架，其特征在于，包括：

获取单元，用于获取接口文档，对所述接口文档进行注释；

解析单元，用于请求参数json解析,将json数据自动解析并填充到请求参数表单；

测试单元，用于对所述接口进行测试，使所述接口满足预定功能需求；

存储单元，用于若测试成功，通过cookie进行参数记忆，对于请求过的接口，在页面记忆输入过的值。

可选的，还包括：

添加单元，用于添加pom依赖；添加接口控制器到spring配置文件。

可选的，所述接口文档包括：

接口名称、参数名称、参数类型、参数描述。

可选的，所述测试单元还用于：

在接口测试表达添加表单扩展字段，提交测试后将所述扩展字段传到后台。

根据本发明的具体实施方式，第三方面，本发明提供一种计算机可读存储介质，其上存储有计算机程序，所述程序被处理器执行时实现如上任一项所述的方法。

根据本发明的具体实施方式，第四方面，本发明提供一种电子设备，包括：一个或多个处理器；存储装置，用于存储一个或多个程序，当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器实现如上任一项所述的方法。

本发明实施例的上述方案与现有技术相比，至少具有以下有益效果：使用API自动生成通用接口组件以后，后端开发人员无需人工维护接口文档，只需要启动项目，前端工程师就可以直接访问对应的接口地址，即可获取到最新接口的方法入参、出参、参数类型、接口描述等信息，也可以直接填入测试数据发送请求获取接口返回数据。这样，后端工程师就可以把更多的精力专注于业务逻辑的实现，无需人工维护接口文档，大大提高前后端分离开发产品的效率。

附图说明

此处的附图被并入说明书中并构成本说明书的一部分，示出了符合本发明的实施例，并与说明书一起用于解释本发明的原理。显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。在附图中：

图1示出了根据本发明某一实施例的接口配置方法流程图；

图2示出了根据本发明另一实施例的接口配置方法流程图；

图3示出了根据本发明实施例的接口配置装置结构示意图本发明图。

具体实施方式

为了使本发明的目的、技术方案和优点更加清楚，下面将结合附图对本发明作进一步地详细描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其它实施例，都属于本发明保护的范围。

在本发明实施例中使用的术语是仅仅出于描述特定实施例的目的，而非旨在限制本发明。在本发明实施例和所附权利要求书中所使用的单数形式的“一种”、“所述”和“该”也旨在包括多数形式，除非上下文清楚地表示其他含义，“多种”一般包含至少两种。

应当理解，本文中使用的术语“和/或”仅仅是一种描述关联对象的关联关系，表示可以存在三种关系，例如，A和/或B，可以表示：单独存在A，同时存在A和B，单独存在B这三种情况。另外，本文中字符“/”，一般表示前后关联对象是一种“或”的关系。

应当理解，尽管在本发明实施例中可能采用术语第一、第二、第三等来描述……，但这些……不应限于这些术语。这些术语仅用来将……区分开。例如，在不脱离本发明实施例范围的情况下，第一……也可以被称为第二……，类似地，第二……也可以被称为第一……。

取决于语境，如在此所使用的词语“如果”、“若”可以被解释成为“在……时”或“当……时”或“响应于确定”或“响应于检测”。类似地，取决于语境，短语“如果确定”或“如果检测(陈述的条件或事件)”可以被解释成为“当确定时”或“响应于确定”或“当检测(陈述的条件或事件)时”或“响应于检测(陈述的条件或事件)”。

还需要说明的是，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的商品或者装置不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种商品或者装置所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的商品或者装置中还存在另外的相同要素。

下面结合附图详细说明本发明的可选实施例。

实施例1

如图1所示，根据本发明的某一具体实施方式，本发明提出一种接口配置方法，应用于SpringMVC框架，包括：

一种接口配置方法，应用于SpringMVC框架，其特征在于，包括：

获取接口文档，；

对请求参数执行json解析；

基于解析结果对所述接口进行配置。

可选的，所述获取接口文档后，还需要对所述接口文档进行注释。

可选的，所述对请求参数执行json解析具体包括：

将json数据自动解析并填充到请求参数表单。

可选的，所述方法还包括：

对所述接口进行测试；

基于测试结果进行操作。

可选的，所述基于测试结果进行操作包括：

若测试成功，通过cookie进行参数记忆。如图2所示，根据本发明的另一具体实施方式，本发明提出一种接口配置方法，应用于SpringMVC框架，包括：

S1：获取接口文档，对所述接口文档进行注释；

S2：请求参数json解析,将json数据自动解析并填充到请求参数表单；

S3：对所述接口进行测试，使所述接口满足预定功能需求；

S4：若测试成功，通过cookie进行参数记忆，对于请求过的接口，在页面记忆输入过的值。

可选的，所述获取接口文档，对所述接口文档进行注释之后，包括：

S11：添加pom依赖；添加接口控制器到spring配置文件。

可选的，所述接口文档包括：

接口名称、参数名称、参数类型、参数描述。

可选的，所述对所述接口进行测试，使所述接口满足预定功能需求，包括：

S31：在接口测试表达添加表单扩展字段，提交测试后将所述扩展字段传到后台。

接口接入：

添加pom依赖，版本请使用最新版本。添加接口控制器到spring配置文件，注意：如果扫描器已经扫描了该控制器请注意排除。

其中，adapter属性：接口处理适配器，目前有两个，也可以自定义适配器，需要实现BaseAdapter接口。

docScanPackages属性：需要扫描的包路径

extendFields属性：表单扩展字段，在如下位置显示，提交测试时会将该扩展字段传到后台。

使用API自动生成通用接口组件以后，后端开发人员无需人工维护接口文档，只需要启动项目，前端工程师就可以直接访问对应的接口地址，即可获取到最新接口的方法入参、出参、参数类型、接口描述等信息，也可以直接填入测试数据发送请求获取接口返回数据。这样，后端工程师就可以把更多的精力专注于业务逻辑的实现，无需人工维护接口文档，大大提高前后端分离开发产品的效率。

实施例2

如图2所示，根据本发明的具体实施方式，第二方面，本发明提供一种接口配置装置，应用于SpringMVC框架，包括：

获取单元202，用于获取接口文档，对所述接口文档进行注释；

解析单元204，用于请求参数json解析,将json数据自动解析并填充到请求参数表单；

测试单元206，用于对所述接口进行测试，使所述接口满足预定功能需求；

存储单元208，用于若测试成功，通过cookie进行参数记忆，对于请求过的接口，在页面记忆输入过的值。

可选的，还包括：

添加单元，用于添加pom依赖；添加接口控制器到spring配置文件。

可选的，所述接口文档包括：

接口名称、参数名称、参数类型、参数描述。

可选的，所述测试单元还用于：

在接口测试表达添加表单扩展字段，提交测试后将所述扩展字段传到后台。

接口接入：

添加pom依赖，版本请使用最新版本。添加接口控制器到spring配置文件，注意：如果扫描器已经扫描了该控制器请注意排除。

其中，adapter属性：接口处理适配器，目前有两个，也可以自定义适配器，需要实现BaseAdapter接口。

docScanPackages属性：需要扫描的包路径

extendFields属性：表单扩展字段，在如下位置显示，提交测试时会将该扩展字段传到后台。

使用API自动生成通用接口组件以后，后端开发人员无需人工维护接口文档，只需要启动项目，前端工程师就可以直接访问对应的接口地址，即可获取到最新接口的方法入参、出参、参数类型、接口描述等信息，也可以直接填入测试数据发送请求获取接口返回数据。这样，后端工程师就可以把更多的精力专注于业务逻辑的实现，无需人工维护接口文档，大大提高前后端分离开发产品的效率。

实施例3

如图3所示，本实施例提供一种电子设备，所述电子设备，包括：至少一个处理器；以及，与所述至少一个处理器通信连接的存储器；其中，

所述存储器存储有可被所述一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够执行如上实施例所述的方法步骤。

实施例4

本发明实施例提供了一种非易失性计算机存储介质，所述计算机存储介质存储有计算机可执行指令，该计算机可执行指令可执行如上实施例所述的方法步骤。

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

上述计算机可读介质可以是上述电子设备中所包含的；也可以是单独存在，而未装配入该电子设备中。

可以以一种或多种程序设计语言或其组合来编写用于执行本发明的操作的计算机程序代码，上述程序设计语言包括面向对象的程序设计语言—诸如Java、Smalltalk、C++，还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络——包括局域网(LAN)或广域网(WAN)—连接到用户计算机，或者，可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。

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

描述于本发明实施例中所涉及到的单元可以通过软件的方式实现，也可以通过硬件的方式来实现。其中，单元的名称在某种情况下并不构成对该单元本身的限定。

Claims (10)

1.一种接口配置方法，应用于SpringMVC框架，其特征在于，包括：

获取接口文档；

对请求参数执行json解析；

基于解析结果对所述接口进行配置。

2.如权利要求1所述的方法，其特征在于，所述获取接口文档后，还需要对所述接口文档进行注释。

3.如权利要求1所述的方法，其特征在于，所述对请求参数执行json解析具体包括：

将json数据自动解析并填充到请求参数表单。

4.如权利要求1所述的方法，其特征在于，所述方法还包括：

对所述接口进行测试；

基于测试结果进行操作。

5.如权利要求4所述的方法，其特征在于，所述基于测试结果进行操作包括：

若测试成功，通过cookie进行参数记忆。

6.如权利要求4所述的方法，其特征在于，所述基于测试结果进行操作还包括：

对于请求过的接口，自动填写输入过的值。

7.如权利要求2所述的方法，其特征在于，所述获取接口文档，对所述接口文档进行注释之后，包括：

添加pom依赖；

添加接口控制器到spring配置文件。

8.一种对外接口配置装置，应用于SpringMVC框架，其特征在于，包括：

获取单元，用于获取接口文档，对所述接口文档进行注释；

解析单元，用于请求参数json解析,将json数据自动解析并填充到请求参数表单；

测试单元，用于对所述接口进行测试，使所述接口满足预定功能需求；

存储单元，用于若测试成功，通过cookie进行参数记忆，对于请求过的接口，在页面记忆输入过的值。

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

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

一个或多个处理器；

存储装置，用于存储一个或多个程序，当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器实现如权利要求1至7中任一项所述的方法。