The invention discloses an interface file parsing method and device. The method includes: receiving a user interface for the call request; from the corresponding file interface, one or more interface elements to obtain corresponding interface; export one or more interface elements in the document, to show to the user. According to the technical scheme of the invention, the user interface in the call, no longer need to read the document and relevant content from the interface to find the interface, but for automatic interface elements presents the user required call interface, so that the user interface is the related elements on the understanding, is conducive to the rapid completion of the call interface compared with the existing technical scheme, save time and improve efficiency.
【技术实现步骤摘要】
接口文件解析方法和装置
本专利技术涉及数据处理
,尤其涉及一种接口文件解析方法和装置。
技术介绍
在通常的项目管理中,对接口文档(例如restful类型接口文件)的管理相当的繁琐,需根据不同的领域进行划分。在开发的过程中往往又伴随着接口的变更、删除和添加操作,因此在维护API接口的同时,需要维护API接口文档,在时间成本和人力成本上有了大大的支出。另外不同的产品可能发布不同的API接口,因而要在日常维护的接口文档全集中筛选出本次发布的版本/产品中需要对外提供的接口信息,以免造成接口泄露/后门漏洞等一系列影响到信息安全以及相关知识产权的问题,对版本管理也是一大负担。一般接口文件属于阅读型文档,用户在调用接口时,需要去寻找该接口所在文档的位置,并完全了解其实际请求头和body(正文)结构。而开发人员每开发一个接口,就需要去更新相应的接口文档,并需要完全按照相关文件类型的语法进行注解,才能呈现给用户一个可阅读而不可操作的文档输出。
技术实现思路
有鉴于此,本专利技术的目的在于提供一种接口文件解析方法和装置,以克服用户在调用接口时需要自行查阅接口文档的问题。本专利技术解决上述技术问题所采用的技术方案如下:根据本专利技术的一个方面,提供的一种接口文件解析方法,包括:接收用户对接口的调用请求;从所述接口对应的接口文件中,获取所述接口对应的一个或多个接口元素;将所述一个或多个接口元素导出到文档中,以展示给所述用户。可选地,前述的方法,所述接口文件中预设有与所述一个或多个接口元素中的至少一个接口元素对应的注解信息;所述方法还包括:将所述注解信息导出到所述文档中,以展示给 ...
【技术保护点】
一种接口文件解析方法,其特征在于,包括:接收用户对接口的调用请求;从所述接口对应的接口文件中,获取所述接口对应的一个或多个接口元素;将所述一个或多个接口元素导出到文档中,以展示给所述用户。
【技术特征摘要】
1.一种接口文件解析方法,其特征在于,包括:接收用户对接口的调用请求;从所述接口对应的接口文件中,获取所述接口对应的一个或多个接口元素;将所述一个或多个接口元素导出到文档中,以展示给所述用户。2.根据权利要求1所述的方法,其特征在于,所述接口文件中预设有与所述一个或多个接口元素中的至少一个接口元素对应的注解信息;所述方法还包括:将所述注解信息导出到所述文档中,以展示给所述用户。3.根据权利要求2所述的方法,其特征在于,所述至少一个接口元素包括:所述接口的返回值,以及所述接口的所需参数和/或请求首部。4.根据权利要求1所述的方法,其特征在于,所述接口文件中预设有与所述接口对应的标识信息;在从所述接口对应的接口文件中,获取所述接口对应的一个或多个接口元素之前,包括:根据所述标识信息从所述接口文件中查找所述接口。5.根据权利要求1所述的方法,其特征在于,将所述一个或多个接口元素导出到文档中,具体包括:按预设的导出路径导出所述文档。6.根据权利要求1至5中任一...
【专利技术属性】
技术研发人员:陈珑,
申请(专利权)人:中兴通讯股份有限公司,
类型:发明
国别省市:广东,44
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。