接口文件解析方法和装置与流程

本发明涉及数据处理技术领域，尤其涉及一种接口文件解析方法和装置。

背景技术：

在通常的项目管理中,对接口文档(例如restful类型接口文件)的管理相当的繁琐，需根据不同的领域进行划分。在开发的过程中往往又伴随着接口的变更、删除和添加操作，因此在维护api接口的同时,需要维护api接口文档,在时间成本和人力成本上有了大大的支出。

另外不同的产品可能发布不同的api接口，因而要在日常维护的接口文档全集中筛选出本次发布的版本/产品中需要对外提供的接口信息,以免造成接口泄露/后门漏洞等一系列影响到信息安全以及相关知识产权的问题，对版本管理也是一大负担。

一般接口文件属于阅读型文档,用户在调用接口时,需要去寻找该接口所在文档的位置,并完全了解其实际请求头和body(正文)结构。而开发人员每开发一个接口,就需要去更新相应的接口文档,并需要完全按照相关文件类型的语法进行注解,才能呈现给用户一个可阅读而不可操作的文档输出。

技术实现要素：

有鉴于此，本发明的目的在于提供一种接口文件解析方法和装置,以克服用户在调用接口时需要自行查阅接口文档的问题。

本发明解决上述技术问题所采用的技术方案如下：

根据本发明的一个方面，提供的一种接口文件解析方法，包括：接收用户对接口的调用请求；从所述接口对应的接口文件中，获取所述接口对应的一个或多个接口元素；将所述一个或多个接口元素导出到文档中，以展示给所述用户。

可选地，前述的方法，所述接口文件中预设有与所述一个或多个接口元素中的至少一个接口元素对应的注解信息；所述方法还包括：将所述注解信息导出到所述文档中，以展示给所述用户。

可选地，前述的方法，所述至少一个接口元素包括：所述接口的返回值，以及所述接口的所需参数和/或请求首部。

可选地，前述的方法，所述接口文件中预设有与所述接口对应的标识信息；在从所述接口对应的接口文件中，获取所述接口对应的一个或多个接口元素之前，包括：根据所述标识信息从所述接口文件中查找所述接口。

可选地，前述的方法，将所述一个或多个接口元素导出到文档中，具体包括：按预设的导出路径导出所述文档。

可选地，前述的方法，还包括：接收所述用户对所述文档中的任一接口元素的操作请求；对所述任一接口元素执行所述操作请求对应的操作。

根据本发明的另一方面，提供的一种接口文件解析装置，包括：调用请求接收模块，用于接收用户对接口的调用请求；接口元素获取模块，用于从所述接口对应的接口文件中，获取所述接口对应的一个或多个接口元素；文档导出模块，用于将所述一个或多个接口元素导出到文档中，以展示给所述用户。

可选地，前述的装置，所述接口文件中预设有与所述一个或多个接口元素中的至少一个接口元素对应的注解信息；所述文档导出模块将所述注解信息导出到所述文档中，以展示给所述用户。

可选地，前述的装置，所述至少一个接口元素包括：所述接口的返回值，以及所述接口的所需参数和/或请求首部。

可选地，前述的装置，所述接口文件中预设有与所述接口对应的标识信息；所述装置还包括：接口查找模块，用于根据所述标识信息从所述接口文件中查找所述接口。

可选地，前述的装置，所述文档导出模块按预设的导出路径导出所述文档。

可选地，前述的装置，还包括：操作请求接收模块，用于接收所述用户对所述文档中的任一接口元素的操作请求；操作模块，用于对所述任一接口元素执行所述操作请求对应的操作。

根据以上技术方案，可知本发明的接口文件解析方法和装置至少具有以下优点：

根据本发明的技术方案，用户在进行接口调用时，不再需要自行阅读接口文档并从中查找该接口的相关内容，而是自动为用户呈现所需调用接口的相关接口元素，使得用户对该接口的相关元素有所了解，有利于快速完成对接口的调用，相比于现有技术方案节省了时间提高了效率。

附图说明

图1为本发明实施例的一种接口文件解析方法的流程图；

图2为本发明实施例的一种接口文件解析方法的流程图；

图3为本发明实施例的一种接口文件解析装置的框图；

图4为本发明实施例的一种接口文件解析装置的框图。

本发明目的的实现、功能特点及优点将结合实施例，参照附图做进一步说明。

具体实施方式

为了使本发明所要解决的技术问题、技术方案及有益效果更加清楚、明白，以下结合附图和实施例，对本发明进行进一步详细说明。应当理解，此处所描述的具体实施例仅仅用以解释本发明，并不用于限定本发明。

如图1所示，本发明的一个实施例中提供了一种接口文件解析方法，包括：

步骤s110，接收用户对接口的调用请求。

步骤s120，从接口对应的接口文件中，获取接口对应的一个或多个接口元素。在本实施例中，对于接口元素的类型不进行限制，具体可以包括返回值、参数模板举例、请求首部、对应转换curl命令等。

步骤s130，将一个或多个接口元素导出到文档中，以展示给用户。在本实施例中，根据本实施例的方案可以实现一种解析工具，用户在解析工具中填入需要调用的接口，可以显示出当前接口的整个数据体系：返回值、参数模板举例、请求首部、对应转换curl命令等。

根据本实施例的技术方案，用户在进行接口调用时，不再需要自行阅读接口文档并从中查找该接口的相关内容，而是自动为用户呈现所需调用接口的相关接口元素，使得用户对该接口的相关元素有所了解，有利于快速完成对接口的调用，相比于现有技术方案节省了时间提高了效率。

如图2所示，本发明的一个实施例中提供了一种接口文件解析方法，包括：

步骤s210，接收用户对接口的调用请求。

步骤s220，根据标识信息从接口文件中查找接口，该接口文件中预设有与接口对应的标识信息。在本实施例中，需要在接口文件中，预先根据当前需要发布对外的api接口做整理,将所有接口进行标识，即标注所有需要发布的api接口，使得用户调用接口时能够及时发现该接口。根据本实施例的技术方案，可以针对有限的接口进行标识，以将其公开给用户进行调用，其他接口的信息则可以不公开给用户，以保证接口的安全性。

步骤s230，从接口对应的接口文件中，获取接口对应的一个或多个接口元素，以及接口文件中预设的与一个或多个接口元素中的至少一个接口元素对应的注解信息。进行注解的接口元素可以包括：接口的返回值，以及所述接口的所需参数和/或请求首部。在本实施例中，根据相应的标识信息,解析api接口所在文件,获取当前标注的所有接口对应的参数,请求首部以及所有可能的返回值,将其所有信息注入到对应匹配的文件中。新增的注解信息可以是接口描述信息,用户接口使用方法和场景说明等。新增的接口参数、返回值等的注解信息，随同接口发布。在本实施例中，对该接口的参数所做的注解,例如适当添加的描述信息,有利于查找与理解接口元素。

在本实施例中，在接口文件中需要预先将所需参数、请求首部等进行注解,以实现通过导出方法将相关文档生成,通过解析该文件将其内容对用户呈现可视化/可操作性。且在接口发生变更且对应参数结构变化时,需要同步对接口文件进行修改。根据本实施例的技术方案，可见接口文档的格式统一规划,这方便文档管理和发布。

步骤s240，按预设的导出路径导出文档，并将一个或多个接口元素和注解信息导出到文档中，以展示给用户。在本实施例中，在api接口文件找到需要对外发布的接口后，对该接口添加文档输出路径，并标识其路由地址。则对接口文件进行解析时，根据之前添加的注解，会在先前制定的文档输出路径中生成相应的接口文档。

步骤s250，接收用户对文档中的任一接口元素的操作请求。在本实施例中，所采用的文档格式包括但不限于json格式，方便用户查看以及操作，其格式例如：

以上表明该接口返回的变量参数,string并非每个变量的值,而是该变量的实际类型。基于该类型的文档，易于实现用户的操作请求的响应，实现对接口元素的操作，所以导出的文档具有可操作性。

步骤s260，对任一接口元素执行操作请求对应的操作。基于本实施例的技术方案所实现的解析工具，使得接口文件通过该工具进行解析,并将上述接口元素在界面中呈现出来,使用户可操作。在本实施例中，通过导入文档路径(可使用url方式)，解析该文档，并转换成可视化且可操作界面。

根据本实施例的技术方案，根据自定义api标识,将接口代码转换成可视图文档，并配合相应的工具解析其结构,将api接口的各个元素(包括body,requesthead(请求首部),对应curl命令转换)显示给用户看,方便用户使用。克服现有人力手动编辑并维护api接口文档的工作,并规避文档的阅读性差的问题,使得开发人员在开发的同时可以并行维护接口,不用关注文档的问题,最终相关接口信息的文档可按版本/产品规划自动生成并对外交付。

如图3所示，本发明的一个实施例中提供了一种接口文件解析装置，包括：

调用请求接收模块310，接收用户对接口的调用请求。

接口元素获取模块320，从接口对应的接口文件中，获取接口对应的一个或多个接口元素。在本实施例中，对于接口元素的类型不进行限制，具体可以包括返回值、参数模板举例、请求首部、对应转换curl命令等。

文档导出模块330，将一个或多个接口元素导出到文档中，以展示给用户。在本实施例中，根据本实施例的方案可以实现一种解析工具，用户在解析工具中填入需要调用的接口，可以显示出当前接口的整个数据体系：返回值、参数模板举例、请求首部、对应转换curl命令等。

根据本实施例的技术方案，用户在进行接口调用时，不再需要自行阅读接口文档并从中查找该接口的相关内容，而是自动为用户呈现所需调用接口的相关接口元素，使得用户对该接口的相关元素有所了解，有利于快速完成对接口的调用，相比于现有技术方案节省了时间提高了效率。

如图4所示，本发明的一个实施例中提供了一种接口文件解析装置，包括：

调用请求接收模块410，接收用户对接口的调用请求。

接口查找模块420，根据标识信息从接口文件中查找接口，该接口文件中预设有与接口对应的标识信息。在本实施例中，需要在接口文件中，预先根据当前需要发布对外的api接口做整理,将所有接口进行标识，即标注所有需要发布的api接口，使得用户调用接口时能够及时发现该接口。根据本实施例的技术方案，可以针对有限的接口进行标识，以将其公开给用户进行调用，其他接口的信息则可以不公开给用户，以保证接口的安全性。

接口元素获取模块430，从接口对应的接口文件中，获取接口对应的一个或多个接口元素，以及接口文件中预设的与一个或多个接口元素中的至少一个接口元素对应的注解信息。进行注解的接口元素可以包括：接口的返回值，以及接口的所需参数和/或请求首部。在本实施例中，根据相应的标识信息,解析api接口所在文件,获取当前标注的所有接口对应的参数,请求首部以及所有可能的返回值,将其所有信息注入到对应匹配的文件中。新增的注解信息可以是接口描述信息,用户接口使用方法和场景说明等。新增的接口参数、返回值等的注解信息，随同接口发布。在本实施例中，对该接口的参数所做的注解,例如适当添加的描述信息,有利于查找与理解接口元素。

在本实施例中，在接口文件中需要预先将所需参数、请求首部等进行注解,以实现通过导出方法将相关文档生成,通过解析该文件将其内容对用户呈现可视化/可操作性。且在接口发生变更且对应参数结构变化时,需要同步对接口文件进行修改。根据本实施例的技术方案，可见接口文档的格式统一规划,这方便文档管理和发布。

文档导出模块440，按预设的导出路径导出文档，并将一个或多个接口元素和注解信息导出到文档中，以展示给用户。在本实施例中，在api接口文件找到需要对外发布的接口后，对该接口添加文档输出路径，并标识其路由地址。则对接口文件进行解析时，根据之前添加的注解，会在先前制定的文档输出路径中生成相应的接口文档。

操作请求接收模块450，接收用户对文档中的任一接口元素的操作请求。在本实施例中，所采用的文档格式包括但不限于json格式，方便用户查看以及操作，其格式例如：

以上表明该接口返回的变量参数,string并非每个变量的值,而是该变量的实际类型。基于该类型的文档，易于实现用户的操作请求的响应，实现对接口元素的操作，所以导出的文档具有可操作性。

操作模块460，对任一接口元素执行操作请求对应的操作。基于本实施例的技术方案所实现的解析工具，使得接口文件通过该工具进行解析,并将上述接口元素在界面中呈现出来,使用户可操作。在本实施例中，通过导入文档路径(可使用url方式)，解析该文档，并转换成可视化且可操作界面。

根据本实施例的技术方案，根据自定义api标识,将接口代码转换成可视图文档，并配合相应的工具解析其结构,将api接口的各个元素(包括body,requesthead(请求首部),对应curl命令转换)显示给用户看,方便用户使用。克服现有人力手动编辑并维护api接口文档的工作,并规避文档的阅读性差的问题,使得开发人员在开发的同时可以并行维护接口,不用关注文档的问题,最终相关接口信息的文档可按版本/产品规划自动生成并对外交付。

以上参照附图说明了本发明的优选实施例，并非因此局限本发明的权利范围。本领域技术人员不脱离本发明的范围和实质，可以有多种变型方案实现本发明，比如作为一个实施例的特征可用于另一实施例而得到又一实施例。凡在运用本发明的技术构思之内所作的任何修改、等同替换和改进，均应在本发明的权利范围之内。