CN111506365A

CN111506365A - 一种自动构建api的方法及装置

Info

Publication number: CN111506365A
Application number: CN201910098858.9A
Authority: CN
Inventors: 冯骏骅; 万振; 赵鹏
Original assignee: Beijing Shuju Xinyun Information Technology Co ltd
Current assignee: Beijing Shuju Xinyun Information Technology Co ltd
Priority date: 2019-01-31
Filing date: 2019-01-31
Publication date: 2020-08-07

Abstract

本发明提供了一种自动构建API的方法和装置，包括判断参数源的类型；根据参数源的类型选择参数源的解析规则；根据解析规则从参数源中按顺序解析出路径及对应参数；使用路径及对应参数构建API；通过自动化的方式对API的参数进行自动获取，有效避免托管API时因手动输入API参数信息造成的低效和配置失误等情况。

Description

一种自动构建API的方法及装置

技术领域

本发明涉及网络技术领域，尤其涉及API托管领域。

背景技术

在API托管平台对API进行配置时会遇到手动输入API相关参数信息的情况，在某些场景下，API的参数会比较多，人工手动进行配置，效率不高且容易引入新的错误。

发明内容

本发明旨在解决上面描述的问题。本发明的一个目的是通过自动化的方式对API的参数进行自动获取，有效避免托管API时因手动输入API参数信息造成的低效和配置失误等情况。

具体地，本发明提供一种自动构建API的方法及装置。

自动构建API的方法，包括：判断参数源的类型；根据参数源的类型选择参数源的解析规则；根据解析规则从参数源中按顺序解析出路径及对应参数；使用路径及对应参数构建API。

参数源的类型是单个URL时，选择URL解析规则；URL解析规则包括，在参数源URL中查找参数体起始标识符，获取参数体，在参数体中根据参数分隔符确定出参数。

参数源的类型是单个CURL时,选择CURL解析规则；CURL解析规则包括，在参数源CURL中查找参数体起始标识符，获取参数体，在参数体中根据参数分隔符确定出qurey参数；在参数源CURL中查找参数类型标志，获取header参数及body参数。

参数源的类型为文本时，选择文本解析规则；文本解析规则包括：行划分规则，行类型划分规则；行划分规则对文本内容进行划分，划分出不同的行，一行代表一个URL或一个CURL；行类型划分规则对行划分规则划分出的行进行类型划分，确定该行为URL类型或CURL类型；针对URL类型使用URL解析规则解析出参数；针对CURL类型使用CURL解析规则解析出参数。

针对URL或CURL解析参数时，将参数及对应的路径存入内存，并在路径前增加顺序标识；按顺序标识读取内存中的路径和参数，构建API。

自动构建API的装置，包括：

参数源类型判断模块：判断参数源类型，参数源类型包括URL类型，CURL类型，文本类型；解析规则选择模块：根据参数源的类型选择对应的解析规则；参数提取模块：根据解析规则自动从参数源中按顺序提取路径及参数，将路径和参数存放到内存中；参数填充模块：从内存中读取路径和参数，并将路径及参数构建成完整API。

参数源的类型为文本时，选择文本解析规则；文本解析规则包括：行划分规则，行类型划分规则；行划分规则对文本内容进行划分，划分出不同的行，一行代表一个URL或一个CURL；行类型划分规则对行划分规则划分出的行进行类型划分，确定该行为URL类型或CURL类型；针对URL类型使用URL解析规则；针对CURL类型使用CURL解析规则。

参数提取模块根据解析规则自动从参数源中按顺序提取路径及参数，将所获路径和参数存放到内存中，同时在路径前面加上顺序标识；参数填充模块按顺序标识从内存中读取路径及对应参数。

参照附图来阅读对于示例性实施例的以下描述，本发明的其他特性特征和优点将变得清晰。

附图说明

并入到说明书中并且构成说明书的一部分的附图示出了本发明的实施例，并且与描述一起用于解释本发明的原理。在这些附图中，类似的附图标记用于表示类似的要素。下面描述中的附图是本发明的一些实施例，而不是全部实施例。对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，可以根据这些附图获得其他的附图。

图1是自动构建API的流程图。

图2是自动构建API的结构图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。需要说明的是，在不冲突的情况下，本申请中的实施例及实施例中的特征可以相互任意组合。

如图1所示一种自动构建API的方法，包括：

步骤1：判断参数源的类型；

步骤2：根据参数源的类型选择参数源的解析规则；

步骤3：根据解析规则从参数源中按顺序解析出路径及对应参数；

步骤4：使用路径及对应参数构建API。

其中，步骤1判断所输入的参数源的类型，本发明涉及的参数源包括单个URL，单个CURL，以及包含多个URL和/或CURL的文本；

当参数源的类型是单个URL时，选择URL解析规则；

URL解析规则包括，在参数源URL中查找参数体起始标识符，获取参数体，在参数体中根据参数分隔符确定出参数。

例如：当输入如下

http://172.18.28.248:5556/api/project/11701？versionId＝0&pageNumber＝1&pageSize＝20&getParent＝true所示的URL时，URL解析规则在上述URL中查找参数体起始标识符“？”，获取参数体versionId＝0&pageNumber＝1&pageSize＝20&getParent＝true，然后根据参数体内的参数分隔符“&”确定如下四个参数：versionId，pageNumber，pageSize，getParent。

在获取参数的同时，获取上述URL的路径：http://172.18.28.248:5556/api/project/11701。

当参数源的类型是单个CURL时,选择CURL解析规则；

CURL解析规则包括，在参数源CURL中查找参数体起始标识符，获取参数体，在参数体中根据参数分隔符确定出qurey参数；在参数源CURL中查找参数类型标志，通过查找“-H”标志,获取header参数；查找“--data-binary”标志，获取body参数。

例如：

curl'http://172.18.28.248:5556/project'-H'Origin:http://172.18.28.248:8888'-H'Content-Type:application/json；charset＝UTF-8'-H'Accept:application/json,text/plain,*/*'--data-binary'{"alias":"yipng","description":"","name":"yipng","schemes":1,"organizationId":"1","envIds":[101],"path":"/"}'

所示的CURL命令，CURL解析规则在上述CURL中查找“-H”,获取head参数：Content-Type＝application，Accept＝application。查找“--data-binary”，获取body参数：alias，description，name，schemes，organizationId，envIds，path。在本例中查找参数体起始标识符“？”,没有找到，说明该CURL中不含query参数。

在获取参数的同时，获取上述CURL的路径：http://172.18.28.248:5556/project。

当参数源的类型为文本时，选择文本解析规则；

文本解析规则包括：行划分规则，行类型划分规则；

行划分规则对文本内容进行划分，划分出不同的行，一行代表一个URL或一个CURL；此处所说的行，是一种逻辑意义上的行，和实际显示的行数无关。

行类型划分规则对行划分规则划分出的行进行类型划分，确定该行为URL类型或CURL类型；

针对URL类型使用URL解析规则解析出参数；针对CURL类型使用CURL解析规则解析出参数。

例如，在一个文本中包括如下内容：

http://172.18.28.248:5556/api/project/11701？versionId＝0&pageNumber＝1&pageSize＝20&getParent＝true

http://173.19.28.248:5556/api/project/11701？versionId＝0&pageNumber＝1&pageSize＝20&getParent＝true

在上述文本中包括URL和CURL命令，文本解析规则为：按行划分规则对文本中的内容进行划分，一个URL作为一行，一个CURL作为一行，在以上文本中共划分出3行，第一行和第二行为URL，使用URL解析规则对第一行和第二行的URL进行解析，第三行为CURL,使用CURL解析规则对第三行的CURL进行解析。

如包含以下内容的文本：

解析出如下路径和参数：

路径1：http://172.18.28.248:5556/api/project/11701

参数：versionId，pageNumber，pageSize，getParent＝true。

路径2：http://173.18.28.248:5556/api/project/11701

参数：versionId，pageNumber，pageSize，getParent。

路径3：http://172.18.28.248:5556/project

参数：Content-Type，Accept，Alias，description，name，schemes，

organizationId，envIds，path。

根据URL或CURL在文本中所在行顺序，解析出各自的路径，并在路径前加顺序标识，在顺序标识和路径之间使用符号“-”隔开，如下所示：1-http://172.18.28.248:5556/api/project/11701

：versionId，pageNumber，pageSize，getParent＝true。2-http://173.18.28.248:5556/api/project/11701

：versionId，pageNumber，pageSize，getParent。3-http://172.18.28.248:5556/project

：Content-Type，Accept，Alias，description，name，schemes，organizationId，

envIds，path。

路径前面增加“数字-”顺序标识后，用数字标识表明该路径和参数的解析顺序；参数与路径对应，并将解析出的路径和参数存贮到内存中。平台按顺序标识，提取内存中的路径及路径对应的参数，自动输入平台系统，构建出多条完整的API，API的条数与顺序标识中最大的数字相同。

通过以上方法，平台对输入的内容自动提取路径和参数，自动填充构建API，避免了人工输入繁琐且容易出错的问题。

一种自动构建API的装置，如图2所示，包括：

参数源类型判断模块：判断参数源类型，参数源类型包括URL类型，CURL类型，文本类型；

解析规则选择模块：根据参数源的类型选择对应的解析规则；

参数提取模块：根据解析规则自动从参数源中按顺序提取路径及参数，将路径和参数存放到内存中；

参数填充模块：从内存中读取路径和参数，并将路径及参数构建成完整API。

参数源的类型是单个URL时，选择URL解析规则；

例如：当输入

http://102.68.28.248:5566/api/project？versionID＝0&pageNumber＝1&papeSi zi＝20&getParent＝ture时，参数源类型判断模块判断输入内容为单个URL类型,并将判断结果传递给解析规则选择模块，解析模块根据参数源为URL类型，选择URL解析规则；参数提取模块根据解析规则对上述URL进行解析，解析后得到如下结构：

在以上结构中，参数提取模块提取了URL的路径及参数，并将其存入内存中。

参数填充模块从内存中读取以上结构中的路径“http://172.18.28.248:5566/api/project”及参数“versioned，pageNumber，getParent”，并将其添加到管理平台。

参数源的类型是单个CURL时,选择CURL解析规则；

CURL解析规则包括，从参数源CURL中查找参数体起始标识符，获取参数体，在参数体中根据参数分隔符确定出qurey参数；在参数源CURL中查找参数类型标志，获取header参数及body参数。

例如：当输入

Curl‘http：//172.18.28.248：5566/project’-H’Origin:http:172.18.28.248:8888’-H

‘Content-Type:application/json；charset＝UTF-8’-H’Accept:application/json,text/plain,*/*’–date-binary’{“alias”:“yipng”,“description”:“”,“name”:“yipng”,“schemes”:1,“organizationId”:“1”,“envIds”:[101]，“path”:“/”时，参数源类型判断模块判断输入内容为单个CURL类型,并将判断结果传递给解析规则选择模块，解析模块根据参数源为CURL类型，选择CURL解析规则；参数提取模块根据解析规则对上述CURL进行解析，解析后得到如下结构：

在以上结构中，参数提取模块提取到CURL中的路径及参数，并将其存入内存中。

参数填充模块读取以上结构中的路径“http://172.18.28.248:5566/project”及header参数“Origin”，“Content-Type”，“Accept”和body参数：“alias”，“description”，“name”，“schemes”，“organizationId”，“envids”，“path”。并将其添加到管理平台。

参数源的类型为文本时，选择文本解析规则；

文本解析规则包括：行划分规则，行类型划分规则；

行划分规则对文本内容进行划分，划分出不同的行，一行代表一个URL或一个CURL；此处所说的行，是一种逻辑意义上的行，和实际显示的行数无关；

针对URL类型使用URL解析规则；针对CURL类型使用CURL解析规则。

参数提取模块根据解析规则自动从参数源中按顺序提取路径及参数，将不同顺序标识对应的路径和参数存放到内存中，同时在路径前面加上顺序标识；参数填充模块按顺序标识从内存中读取路径及对应参数。

例如：有包含以下内容的文本，

http://152.18.38.248:5556/api/project/11701？versionId＝0&pageNumber＝1&pageSize＝20&getParent＝true

当文本上传到管理平台后，参数源类型判断模块判断输入内容为文本类型,并将判断结果传递给解析规则选择模块，解析模块根据参数源为文本类型，选择文本解析规则，使用行划分规则对文本内容进行解析，判断出该文本有3个行，再使用行类型划分规则对文本内的三个行进行划分，确定出第一行和第二行为URL，第三行为CURL。

参数提取模块根据URL解析规则对第一行和第二行的URL进行解析，根据CURL解析规则对第三行的CURL进行解析，解析后得到如下结构：

以上共解析出3组结构，并分别对应于第一行的URL,第二行的URL和第三行的CURL，每组结构中包括路径和对应的参数，并在路径前面添加顺序标识。参数提取模块将上述3个结构中提取到的路径及参数存入内存中。

参数填充模块从内存中按顺序读取各顺序标识对应的路径和参数，并将路径及参数构建成完整API，填充到管理平台。

上面描述的内容可以单独地或者以各种方式组合起来实施，而这些变型方式都在本发明的保护范围之内。

需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包含一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个…”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

最后应说明的是：以上实施例仅用以说明本发明的技术方案，而非对其限制。尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。

Claims

1.一种自动构建API的方法，包括：

判断参数源的类型；

根据所述参数源的类型选择所述参数源的解析规则；

根据解析规则从所述参数源中按顺序解析出路径及对应参数；

使用所述路径及所述对应参数构建API。

2.如权利要求1所述的自动构建API的方法，其特征在于，

所述参数源的类型是单个URL时，选择URL解析规则；

所述URL解析规则包括，在所述参数源URL中查找参数体起始标识符，获取参数体，在所述参数体中根据参数分隔符确定出参数。

3.如权利要求1所述的自动构建API的方法，其特征在于，

所述参数源的类型是单个CURL时,选择CURL解析规则；

所述CURL解析规则包括，在所述参数源CURL中查找参数体起始标识符，获取参数体，在所述参数体中根据参数分隔符确定出qurey参数；在所述参数源CURL中查找参数类型标志，获取header参数及body参数。

4.如权利要求1所述的自动构建API的方法，其特征在于，

所述参数源的类型为文本时，选择文本解析规则；

所述文本解析规则包括：行划分规则，行类型划分规则；

所述行划分规则对文本内容进行划分，划分出不同的行，一行代表一个URL或一个CURL；

所述行类型划分规则对行划分规则划分出的行进行类型划分，确定该行为URL类型或CURL类型；

5.如权利要求1-4任一所述的自动构建API的方法，其特征在于，

针对URL或CURL解析参数时，将所述参数及对应的路径存入内存，并在所述路径前增加顺序标识；按所述顺序标识读取内存中的路径和参数，构建API。

6.一种自动构建API的装置，包括：

参数源类型判断模块：判断参数源类型，所述参数源类型包括URL类型，CURL类型，文本类型；

参数填充模块：从内存中读取路径和参数，并将所述路径及参数构建成完整API。

7.如权利要求6所述的自动构建API的装置，其特征在于，

所述参数源的类型是单个URL时，选择URL解析规则；

8.如权利要求6所述的自动构建API的装置，其特征在于，

所述参数源的类型是单个CURL时,选择CURL解析规则；

9.如权利要求6所述的自动构建API的装置，其特征在于，

所述参数源的类型为文本时，选择文本解析规则；

所述文本解析规则包括：行划分规则，行类型划分规则；

10.如权利要求6-9任一所述的自动构建API的装置，其特征在于，所述参数提取模块根据解析规则自动从参数源中按顺序提取路径及参数，将所获路径和参数存放到内存中，同时在所述路径前面加上顺序标识；所述参数填充模块按所述顺序标识从内存中读取路径及对应参数。