[发明专利]基于Swagger动态生成范本文件的方法、装置及应用

说明书

本申请提出了一种基于Swagger动态生成范本文件的方法、装置及应用，调取swagger提供的api接口以获取webjson格式的文档数据，将所述文档数据转换为json数据格式的数据源；基于所述数据源对应的api接口的分类名称生成对应的接口定义；基于所述接口定义生成Typescript文件；将所述Typescript文件格式化为规范文件，其中所述规范文件符合eslint规范以及prettier美化规范实现了后端开发人员在开发完restfull格式的api接口后，前端开发人员可以通过此工具即时生成Typescript文件，生成文件后,前端开发人员能及时调整编写的代码中类型的不正确或参数丢失引起的项目运行错误。

技术领域

本申请涉及大数据挖掘领域，特别是涉及基于Swagger动态生成范本文件的方法、装置及应用。

背景技术

随着web开发前后端分离，各个工种更加细化，web开发的流程为：后端开发好符合restfull类型的api，同时提供相应的对接文档，定义好api接口的入参类型，中文释义，是否必填，以及返回数据的格式，内容，以及中文释义，继而提供给前端开发人员，而前端开发人员会读取这份文档，编写为适用于前端开发的Typescript文件，同时定义好符合Typescript规范的对应函数的入参以及出参，就能够有效地约束前端开发人员按照文档提供的参数类型传递参数和解析参数。后端人员往往使用Swagger生成对接文档，Swagger能够提供web版的文档，也能够下载对应的doc文件进行查看。前端开发可以有效地使用这份文档编写Typescript文件。

然而软件开发的需求通常在不断变更，为应对如此多的变更，后端开发需要对restfull接口进行不断地修改和变更，借用Swagger的文档系统，后端开发能迅速发布新的文档，前端开发人员则需要实时关注后端对restfull接口的调整，虽然Swagger提供的文档系统能够有效地提示哪些接口经历过变更，以及主要变更在哪里，但由于软件开发往往要求迭代速度快速，前端开发可能忽视于更新Typescript文件。在项目开发过程中，一旦项目开发周期拖长或者软件开发人员出现变动，导致最终没人能够熟悉各个API接口对接方式或变动，使得后端开发人员需要重新阅读源码才能辨别API接口是哪部分在改动或重构,这样致使API对接过程中错误率升高，后端开发人员极大可能选择重构，前端开发人员也需要重复校验Typescript文件和Swagger文档的差异，否则会出现字段缺失，字段类型错误，或者接口完全替换等情况，影响项目开发进度。

而对于前端开发，由于不同开发人员使用的编辑器不同，亦或者是使用的插件不同，所以在代码保存时，可能会进行相应的格式化，那么在多人开发的过程中，开发人员A可能使用Eslint规范的格式插件进行代码格式化，开发人员B可能使用prettier。如果开发人员A和B都将修改Typescript文件并且上传至代码管理仓库，就会因为格式差异产生多条仅修改格式的记录，但实质上，并无达成任何有意义的修改，一方面使得开发人员在bug回溯时不能快速定位问题文件，一方面使开发人员在代码的review过程中忽略项目中关键的代码。如果想要解决这个问题，就需要使用统一的代码格式化工具对代码进行格式化，使得不同的编辑器或插件都能输出相同的Typescript文件,不会触发编辑器的语法错误检查。同时也能保证一定的代码美观度，便于开发者查看。

因此，迫切需要一种能依据生成的web文档解析为相应的Typescript文件的工具或方法，同时能够通过统一的格式化方式规范这部分文件的输出格式，防止代码上传至代码仓库时发生混乱和错误。

发明内容

本申请实施例提供了一种基于Swagger动态生成规范文件的方法、装置及应用，有效地解决了背景技术中提到的问题，方便了java后端与web前端开发的接口对接。

第一方面，本申请实施例提供了一种基于Swagger动态生成规范文件的方法，包括以下步骤：

调取swagger提供的api接口以获取webjson格式的文档数据，将所述文档数据转换为json数据格式的数据源；