前端接口数据统一管理的方法与系统技术方案

本申请提供前端接口数据统一管理的方法与系统，属于web前端开发技术领域，方法先获取开发者创建的应用信息并生成对应的应用ID；然后获取并解析后端根据应用信息编辑的接口文档，生成相应接口的请求数据同时通过页面展示解析结果；将预设的SDK引入前端项目并依据应用ID进行项目初始化，同时统一配置前端项目的请求地址；利用预设的SDK拦截前端发出的接口请求，确定接口请求对应的请求环境并依据请求环境调用接口，从后端获取请求数据返回给前端项目。本申请将前后端的所有接口都是统一接口平台调用，保障了接口请求安全性，减少了项目开发时间，提高了开发效率。提高了开发效率。提高了开发效率。

【技术实现步骤摘要】
前端接口数据统一管理的方法与系统


[0001]本申请属于web前端开发
，具体涉及一种前端接口数据统一管理的方法与系统。

技术介绍

[0002]现在主流开发模式是前后端分离式开发，可以实现前端和后端的同时开发，虽然这种模式解决了前后端开发之间协同工作的效率问题，但也会有部分工作仍比较耗时，比如接口设计，前端需要等待后端输出接口，同时完成参数定义、参数类型标注和参数的特性设置等工作后，才能调用接口进行开发。这样的开发流程，就导致前端开发完成之后联调的过程中又会产生一些不必要的时间浪费，造成了前后端接口数据交互不同步，开发时间较长，开发效率较低。

技术实现思路

[0003]为此，本申请提供前端接口数据统一管理的方法与系统，有助于解决现有web前端开发过程中，前后端接口数据交互不同步，开发时间较长且开发效率较低的问题。
[0004]为实现以上目的，本申请采用如下技术方案：
[0005]第一方面，本申请提供一种前端接口数据统一管理的方法，包括：
[0006]获取开发者创建的应用信息并生成对应的应用ID；
[0007]获取并解析后端根据所述应用信息编辑的接口文档，生成相应接口的请求数据同时通过页面展示解析结果；
[0008]将预设的SDK引入前端项目并依据所述应用ID进行项目初始化，同时统一配置前端项目的请求地址；
[0009]利用预设的SDK拦截前端发出的接口请求，确定所述接口请求对应的请求环境并依据所述请求环境调用接口，从后端获取请求数据返回给前端项目。
[0010]进一步地，所述获取开发者创建的应用信息并生成对应的应用ID，具体包括：
[0011]开发者依据请求环境创建应用，获取开发者创建的应用并依据应用相关的应用信息生成对应的应用ID；所述请求环境具体包括mock环境、开发环境、测试环境和生产环境。
[0012]进一步地，所述获取并解析后端根据所述应用信息编辑的接口文档，生成相应接口的请求数据同时通过页面展示解析结果，具体包括：
[0013]后端根据所述应用信息定义接口信息，并按照预设的数据交换格式对接口信息进行编辑形成接口文档；
[0014]获取所述接口文档并对接口文档进行数据解析，获得所述接口信息后通过页面进行展示以供开发者查看；
[0015]所述接口信息包括接口规范、接口的请求方式、参数类型、参数边界值、必传参数和非必传参数。
[0016]进一步地，所述将预设的SDK引入前端项目并依据所述应用ID进行项目初始化，同
时统一配置前端项目的请求地址，具体包括：
[0017]将预设的SDK引入前端项目中，依据所述应用ID，按照预设的SDK提供的初始化方法进行项目初始化，设置前端项目开发的接口信息；并将前端项目的请求地址统一配置为相同的请求地址。
[0018]进一步地，所述利用预设的SDK拦截前端发出的接口请求，确定所述接口请求对应的请求环境并依据所述请求环境调用接口，从后端获取请求数据返回给前端项目，具体包括：
[0019]前端依据当前的调用环境、设置的接口信息和统一配置的请求地址向后端发出接口请求；
[0020]利用预设的SDK统一拦截前端发出的接口请求，并将调用环境与后端中的请求环境进行匹配，确定所述接口请求对应的请求环境；
[0021]依据确定出的请求环境调用接口，从后端中调用后端服务获取请求数据，并通过调用接口返回请求数据到前端项目中。
[0022]进一步地，方法还包括：
[0023]检测接口的接口文档是否有变更，若接口文档有变更则记录变更后的接口文档与变更前的接口文档之间的接口变化信息；
[0024]当利用预设的SDK统一拦截前端发出的接口请求时，预先检测接口请求中的接口信息与所请求的接口对应接口文档中的接口信息是否匹配，若不匹配则终止该接口请求，并将接口变化信息以console的方式对前端的开发者进行提示；
[0025]前端的开发者根据接口的接口变化信息修正前端项目中的接口信息，并重新提交接口请求。
[0026]第二方面，本申请提供一种前端接口数据统一管理的系统，包括：
[0027]应用创建模块，用于开发者创建应用，并获取开发者创建的应用信息并生成对应的应用ID；
[0028]文件解析模块，用于获取并解析后端根据所述应用信息编辑的接口文档，生成相应接口的请求数据同时通过页面展示解析结果；
[0029]开发工具模块，用于提供预设的SDK和统一的请求地址，以供开发者将预设的SDK引入前端项目并依据所述应用ID进行项目初始化，同时统一配置前端项目的请求地址；
[0030]请求拦截调用模块，用于利用预设的SDK拦截前端发出的接口请求，确定所述接口请求对应的请求环境并依据所述请求环境调用接口，从后端获取请求数据返回给前端项目。
[0031]进一步地，系统还包括文档比对模块，用于检测接口的接口文档是否有变更，并记录变更后的接口文档与变更前的接口文档之间的接口变化信息。
[0032]进一步地，所述请求拦截调用模块还用于预先检测接口请求中的接口信息与所请求的接口对应接口文档中的接口信息是否匹配，若不匹配则终止该接口请求，并将接口变化信息以console的方式对前端的开发者进行提示。
[0033]本申请采用以上技术方案，至少具备以下有益效果：
[0034]通过本申请提供的一种前端接口数据统一管理的方法，方法先获取开发者创建的应用信息并生成对应的应用ID；然后获取并解析后端根据所述应用信息编辑的接口文档，
生成相应接口的请求数据同时通过页面展示解析结果；将预设的SDK引入前端项目并依据所述应用ID进行项目初始化，同时统一配置前端项目的请求地址；最后利用预设的SDK拦截前端发出的接口请求，确定所述接口请求对应的请求环境并依据所述请求环境调用接口，从后端获取请求数据返回给前端项目。本申请通过获取开发者创建的应用信息并生成对应的唯一的应用ID以区分应用，获取并解析后端根据应用信息编辑的接口文档，生成相应接口的请求数据同时通过页面展示解析结果，可以看到当前接口的规范、参数、类型等。然后将预设的SDK引入前端项目并依据所述应用ID进行项目初始化，同时统一配置前端项目的请求地址，统一了接口的调用，可以保障接口请求的安全性，避免了前后端不协调出现接口调用报错的问题，实现数据交互的同步。同时利用SDK拦截前端发出的接口请求并对请求进行处理，通过确定接口请求对应的请求环境来决定请求后端中的相应环境下的数据，最后返回给前端项目，减少了开发时长，同时提高了开发效率。
[0035]应当理解的是，以上的一般描述和后文的细节描述仅是示例性和解释性的，并不能限制本申请。
附图说明
[0036]为了更清楚地说明本申请实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍。
[0037]图1是根据一示例性实施例示出的前端接口数据统一管理的方法流程本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种前端接口数据统一管理的方法，其特征在于，包括：获取开发者创建的应用信息并生成对应的应用ID；获取并解析后端根据所述应用信息编辑的接口文档，生成相应接口的请求数据同时通过页面展示解析结果；将预设的SDK引入前端项目并依据所述应用ID进行项目初始化，同时统一配置前端项目的请求地址；利用预设的SDK拦截前端发出的接口请求，确定所述接口请求对应的请求环境并依据所述请求环境调用接口，从后端获取请求数据返回给前端项目。2.根据权利要求1所述的前端接口数据统一管理的方法，其特征在于，所述获取开发者创建的应用信息并生成对应的应用ID，具体包括：开发者依据请求环境创建应用，获取开发者创建的应用并依据应用相关的应用信息生成对应的应用ID；所述请求环境具体包括mock环境、开发环境、测试环境和生产环境。3.根据权利要求1所述的前端接口数据统一管理的方法，其特征在于，所述获取并解析后端根据所述应用信息编辑的接口文档，生成相应接口的请求数据同时通过页面展示解析结果，具体包括：后端根据所述应用信息定义接口信息，并按照预设的数据交换格式对接口信息进行编辑形成接口文档；获取所述接口文档并对接口文档进行数据解析，获得所述接口信息后通过页面进行展示以供开发者查看；所述接口信息包括接口规范、接口的请求方式、参数类型、参数边界值、必传参数和非必传参数。4.根据权利要求1所述的前端接口数据统一管理的方法，其特征在于，所述将预设的SDK引入前端项目并依据所述应用ID进行项目初始化，同时统一配置前端项目的请求地址，具体包括：将预设的SDK引入前端项目中，依据所述应用ID，按照预设的SDK提供的初始化方法进行项目初始化，设置前端项目开发的接口信息；并将前端项目的请求地址统一配置为相同的请求地址。5.根据权利要求1所述的前端接口数据统一管理的方法，其特征在于，所述利用预设的SDK拦截前端发出的接口请求，确定所述接口请求对应的请求环境并依据所述请求环境调用接口，从后端获取请求数据返回给前端项目，具体包括：前端依据当前的调用环境、设置的接口信息和统一配...

【专利技术属性】
技术研发人员：李鹏鹏，
申请(专利权)人：上海中通吉网络技术有限公司，
类型：发明
国别省市：