CN108228173B - 一种可视化的数据接口开发系统和方法 - Google Patents

Abstract

本发明公开了一种可视化的数据接口开发系统和方法，该系统包括：接口编辑器，用于提供可视化的图形界面以接收API接口描述；接口规范模板库，用于存储模板数据；语法分析器，用于根据模板数据，对API接口描述进行语法分析；代码生成器，用于生成代码；接口调试器，用于提供可视化的图形界面以让用户对接口代码进行调试；本发明为用户提供图形化界面，便于用户编辑和调试，本发明根据模板数据和用户输入的API接口描述进行语法分析，能够规范用户开发的数据接口格式，并且本发明将编辑和调试集成在一起，减少编辑人员和调试人员的沟通成本；本发明能够提升数据接口的开发效率。本发明可以广泛应用在软件开发领域。

Description

一种可视化的数据接口开发系统和方法

技术领域

本发明涉及软件开发领域，尤其是一种可视化的数据接口开发系统和方法。

背景技术

在一些大型的软件集成项目中，除了软件产品本身，还需要采集其他系统的数据，并对这些数据进行相关处理。之所要要采集其他系统的数据，一方面是为了满足产品本身的功能需求，另一方面还要将数据的处理结果反馈给其他系统，因此，必须实现各个系统之间的数据交互。

当前，实现数据交互的主要途径是采用数据接口的方式，即一个系统向另一个系统提供API接口，数据的使用方调用这些API接口来获取数据以及回传处理结果。由于各软件系统的开发语言，以及采用的技术不尽相同，导致提供的接口种类繁多，数据格式不统一；而且集成的系统较多时，各系统之间互相调用，形成网状结构，使得调用关系复杂，调试困难。并且在现实的API接口开发过程中，一般通过口头讨论或者需求文档，制定一套接口规范，开发人员根据接口规范编写代码。再编写API接口的使用说明文档，使用者再根据API的使用说明文档调用接口并处理数据。这种方式存在以下问题：1、API接口的开发和使用过程是割裂的，接口规范的制定人和编写代码的开发人员可能不同，因此经常会出现开发人员对接口和数据格式的理解不同意，导致开发出来的接口和规范不一致的情况。2、接口的开发者和接口的使用者是分割的，接口开发完成后，开发者将接口代码打包后，通过邮件或者其他工具发给使用者。使用者将接口代码加入到自己的程序中进行调试。经常出现API接口的格式和功能与使用说明文档不一致的情况。使得双方的沟通成本提升，降低了开发的效率。

发明内容

为解决上述技术问题，本发明的第一个目的在于：提供一种高效率的可视化的数据接口开发系统。

本发明的第二个目的在于：提供一种高效率的可视化的数据接口开发方法。

本发明所采取的第一种技术方案是：

一种可视化的数据接口开发系统，包括：

接口编辑器，用于提供可视化的图形界面以接收用户输入的API接口描述；

接口规范模板库，用于存储模板数据；

语法分析器，用于根据接口规范模板库中的模板数据，对用户输入的API接口描述进行语法分析；

代码生成器，用于根据用户输入的API接口描述生成代码；

接口调试器，用于提供可视化的图形界面以让用户对代码生成器生成的代码进行调试；

所述语法分析器的输入端分别与接口编辑器的输出端和接口规范模板库的输出端连接，所述语法分析器的输出端与代码生成器的输入端连接，所述代码生成器的输出端与接口调试器的输入端连接。

进一步，所述接口规范模板库包括若干个设定的关键字和语法规则。

进一步，所述语法分析器包括：

词法分析单元，用于将接口编辑器获取的API接口描述拆分成多个单词；

语法分析单元，用于将词法分析单元拆分得到的多个单词与接口规范模板库中的关键字和语法规则进行匹配。

进一步，所述语法分析器还用于根据对用户输入的API接口描述进行分析的结果，判断用户输入的API接口描述是否合格，若是，则通知代码生成器生成代码；反之，则向用户显示错误信息。

本发明所采取的第二种技术方案是：

一种可视化的数据接口开发方法，包括以下步骤：

采用可视化图形界面接收用户输入的API接口描述；

根据模板数据对用户输入的API接口描述进行语法分析，生成API接口代码；

向用户提供所述API接口代码的可视化调试窗口。

进一步，所述模板数据包括若干个设定的关键字和语法规则。

进一步，所述根据模板数据对用户输入的API接口描述进行语法分析，生成API接口代码，这一步骤具体包括：

将用户输入的API接口描述拆分成多个单词；

将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，并根据匹配的结果

生成代码。

进一步，所述将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，并根据匹配的结果生成代码，这一步骤具体为：

将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，判断用户输入的API接口描述是否合格，若是，则根据用户输入的API接口描述生成代码，反之，则向用户显示错误信息。

本发明系统的有益效果是：包括接口编辑器、接口模板规范库、语法分析器、代码生成器和接口调试器，本系统的接口编辑器和接口调试器均为可视化图形界面，便于用户对数据接口进行编辑和调试；本系统增设了接口规范模板库和语法分析器，能够判断用户输入的API接口描述是否符合规范要求，从而避免开发人员写出与接口规范不同的接口代码；并且本系统的接口编辑器和接口调试器集成在一个系统中，减少接口的编辑人员和调试人员的沟通成本；综上所述，本系统可以有效提升数据接口的开发效率。

本发明方法的有益效果是：包括采用可视化图形界面接收用户输入的API接口描述；根据模板数据对用户输入的API接口描述进行语法分析，生成API接口代码；和向用户提供所述API接口代码的可视化调试窗口的步骤，向用户提供可视化的界面，便于用户对接数据口编辑和调试；本方法根据模板数据对用户输入的API描述进行语法分析，能够判断用户输入的API接口描述是否符合规范要求，从而避免开发人员写出与接口规范不同的接口代码而导致的反复修改；并且本方法将API接口的编辑和调试集成在一起，可以减少接口的编辑人员和调试人员的沟通成本；综上所述，本方法可以有效提升数据接口的开发效率。

附图说明

图1为本发明一种可视化的数据接口开发系统的模块框图；

图2为本发明的方法流程图；

图3为本发明一种具体实施例的可视化的数据接口开发系统的模块框图；

图4为本发明一种具体实施例的接口编辑界面示意图(该界面包括两个窗口)；

图5为本发明一种具体实施例的接口调试界面示意图(该界面包括两个窗口)；

图6为本发明一种具体实施例的可视化的数据接口开发方法的流程图。

具体实施方式

参照图1，一种可视化的数据接口开发系统，包括：

接口编辑器，用于提供可视化的图形界面以接收用户输入的API接口描述；

接口规范模板库，用于存储模板数据；

语法分析器，用于根据接口规范模板库中的模板数据，对用户输入的API接口描述进行语法分析；

代码生成器，用于根据用户输入的API接口描述生成代码；

接口调试器，用于提供可视化的图形界面以让用户对代码生成器生成的代码进行调试；

所述语法分析器的输入端分别与接口编辑器的输出端和接口规范模板库的输出端连接，所述语法分析器的输出端与代码生成器的输入端连接，所述代码生成器的输出端与接口调试器的输入端连接。

进一步作为优选的实施方式，所述接口规范模板库包括若干个设定的关键字和语法规则。

进一步作为优选的实施方式，所述语法分析器包括：

词法分析单元，用于将接口编辑器获取的API接口描述拆分成多个单词；

语法分析单元，用于将词法分析单元拆分得到的多个单词与接口规范模板库中的关键字和语法规则进行匹配。

进一步作为优选的实施方式，所述语法分析器还用于根据对用户输入的API接口描述进行分析的结果，判断用户输入的API接口描述是否合格，若是，则通知代码生成器生成代码；反之，则向用户显示错误信息。

参照图2，一种可视化的数据接口开发方法，包括以下步骤：

采用可视化图形界面接收用户输入的API接口描述；

根据模板数据对用户输入的API接口描述进行语法分析，生成API接口代码；

向用户提供所述API接口代码的可视化调试窗口。

进一步作为优选的实施方式，所述模板数据包括若干个设定的关键字和语法规则。

进一步作为优选的实施方式，所述根据模板数据对用户输入的API接口描述进行语法分析，生成API接口代码，这一步骤具体包括：

将用户输入的API接口描述拆分成多个单词；

将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，并根据匹配的结果

生成代码。

进一步作为优选的实施方式，所述将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，并根据匹配的结果生成代码，这一步骤具体为：

将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，判断用户输入的API接口描述是否合格，若是，则根据用户输入的API接口描述生成代码，反之，则向用户显示错误信息。

下面结合说明书附图和具体的实施例对本发明进行进一步的说明。

参照图3，本实施例提供一种可视化的数据接口开发系统，本系统包括：

接口编辑器，用于提供可视化的图形界面以接收用户输入的API接口描述，界面上设有多个设置好的输入框和提示文字；所述接口编辑器接收的API接口描述包括接口名称、版本号、接口描述、主机名称以及接口调用方式等。

接口规范模板库，用于存储模板数据；所述，模板数据包括多个预设的关键字(包括关键字的类型)和语法规则等。户可以在接口规范模板库中规定接口的编程语言，以统一开发语言。在本实施例中，接口规范模板库采用XML格式进行定义，用法分析器可以根据XML的关键字和语法规则判断接口是否符合规范。

语法分析器，用于根据接口规范模板库中的模板数据，对用户输入的API接口描述进行语法分析，并根据语法分析的结果判断用户输入的API接口描述是否符合规范，若是，则通知代码生成器生成代码，反之，则提示向用户提示错误信息。如用户输入的语法不对，语法分析器可以提示用户语法存在问题。语法分析器包括语法分析单元和词法分析单元，其中，词法分析单元，用于将接口编辑器获取的API接口描述拆分成多个单词；语法分析单元，用于将词法分析单元拆分得到的多个单词与接口规范模板库中的关键字和语法规则进行匹配。

代码生成器，用于根据用户输入的API接口描述生成代码；如JSON格式的接口代码。

接口调试器，用于提供可视化的图形界面以让用户对代码生成器生成的代码进行调试；

如图4所示，本实施例示出一种接口编辑器的具体界面(该界面包括编辑窗口和代码窗口)。在图4的左侧设有API接口描述的编辑窗口，由开发者输入如接口名称、版本号、接口描述、主机名称、调用方式和参数表等。其中，接口响应用于显示接口代码执行后是否调用成功，如果调用失败会显示错误信息。用户可以通过点击“生成代码”在右侧的窗口中生成代码，并且右侧窗口是可以编辑的，用户可以根据实际需要修改代码。然后用户可以通过点击“执行”按钮执行接口代码，接口响应向用户显示调用情况。

如图5所示，本实施例示出了一种接口调试器的具体界面(该界面包括接口列表窗口和接口调试窗口)。其中左侧为接口调试器的可用接口列表，用户可以根据需要选择调试的接口，其中可用接口列表中的接口均为通过语法检查并已经生成接口代码的API接口。当用户选中某个接口后，右侧窗口显示该接口的详细信息并可以进行在线调试。右侧窗口为接口调试窗口，该窗口提供三个按钮，分别是“执行”、“查看代码”和“查看接口说明”。用户在点击“执行”按钮后，会启动一个内嵌的小型浏览器，接口代码会在该小型浏览器中运行，并将接口返回的数据显示在下方的数据结果窗口中。用户可以根据数据结果判断接口是否调通。如果按“查看代码”或者“查看接口说明”，用户可以在一个弹出窗口中看到接口代码或者该接口的说明。便于用户调试。

参照图6，本实施例提供了一种可视化的数据接口开发方法，该方法可以采用图3中的数据接口开发系统实现，该方法包括以下步骤：

A、采用可视化图形界面接收用户输入的API接口描述。

B、将用户输入的API接口描述拆分成多个单词。

C、将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，判断用户输入的API接口描述是否合格，若是，则执行步骤D，反之，则向用户显示错误信息。

D、根据用户输入的API接口描述生成代码。

E、向用户提供所述API接口代码的可视化调试窗口。

对于本实施例中的步骤编号，其仅为了便于阐述说明而设置，对步骤之间的顺序不做任何限定，实施例中的各步骤的执行顺序均可根据本领域技术人员的理解来进行适应性调整。

本发明具有以下优点：

1)本发明实用图形化界面，使得用户可以根据界面的内容编辑和调试数据接口，便于用户根据数据接口的规范进行编辑和调试。提升用户的编辑和调试效率。

2)本发明根据模板数据对用户输入的API描述进行语法分析，能够判断用户输入的API接口描述是否符合规范要求，使得开发过程的接口规范得到统一，从而避免开发人员写出与接口规范不同的接口代码而导致的反复修改，能够提升数据接口的开发效率。

3)本发明将API接口的编辑和调试集成在一起，可以减少接口的编辑人员和调试人员的沟通成本，能够提升数据接口的开发效率。

4)本发明的增设接口规范模板库(模板数据)，可以根据实际需要，设置不同的接口开发规范。在需要更换不同的接口规范时，只需要更新模板数据即可，使得本发明能够适应不同开发者的开发需求。

以上是对本发明的较佳实施进行了具体说明，但本发明并不限于所述实施例，熟悉本领域的技术人员在不违背本发明精神的前提下还可做作出种种的等同变形或替换，这些等同的变形或替换均包含在本申请权利要求所限定的范围内。

Claims (6)

1.一种可视化的数据接口开发系统，其特征在于，包括：

接口编辑器，用于提供可视化的图形界面以接收用户输入的API接口描述；

接口规范模板库，用于存储模板数据；

语法分析器，用于根据接口规范模板库中的模板数据，对用户输入的API接口描述进行语法分析；

代码生成器，用于根据用户输入的API接口描述生成代码；

接口调试器，用于提供可视化的图形界面以让用户对代码生成器生成的代码进行调试；

所述语法分析器的输入端分别与接口编辑器的输出端和接口规范模板库的输出端连接，所述语法分析器的输出端与代码生成器的输入端连接，所述代码生成器的输出端与接口调试器的输入端连接；

所述语法分析器包括：

词法分析单元，用于将接口编辑器获取的API接口描述拆分成多个单词；

语法分析单元，用于将词法分析单元拆分得到的多个单词与接口规范模板库中的关键字和语法规则进行匹配。

2.根据权利要求1所述的一种可视化的数据接口开发系统，其特征在于：所述接口规范模板库包括若干个设定的关键字和语法规则。

3.根据权利要求2所述的一种可视化的数据接口开发系统，其特征在于：所述语法分析器还用于根据对用户输入的API接口描述进行分析的结果，判断用户输入的API接口描述是否合格，若是，则通知代码生成器生成代码；反之，则向用户显示错误信息。

4.一种可视化的数据接口开发方法，其特征在于，包括以下步骤：

采用可视化图形界面接收用户输入的API接口描述；

根据模板数据对用户输入的API接口描述进行语法分析，生成API接口代码；

向用户提供所述API接口代码的可视化调试窗口；

所述根据模板数据对用户输入的API接口描述进行语法分析，生成API接口代码，这一步骤具体包括：

将用户输入的API接口描述拆分成多个单词；

将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，并根据匹配的结果生成代码。

5.根据权利要求4所述的一种可视化的数据接口开发方法，其特征在于：所述模板数据包括若干个设定的关键字和语法规则。

6.根据权利要求5所述的一种可视化的数据接口开发方法，其特征在于：所述将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，并根据匹配的结果生成代码，这一步骤具体为：

将拆分得到的多个单词与模板数据中的关键字和语法规则进行匹配，判断用户输入的API接口描述是否合格，若是，则根据用户输入的API接口描述生成代码，反之，则向用户显示错误信息。

Images