一种网络请求与接口文档关联方法、系统及存储介质技术方案

本申请涉及软件开发的技术领域，尤其是涉及一种网络请求与接口文档关联方法、系统及存储介质，其包括：编写用于对请求进行转发或修改的规则以获得若干相应的请求规则；获取请求端发出的网络请求数据；判断网络请求数据是否命中预设的请求规则；若命中，则查找与该请求规则所匹配的接口文档，并根据接口文档对网络请求数据内的接口参数进行校验以获得第一校验结果；根据网络请求数据获取相应的请求结果并返回至请求端；若未命中，则将网络请求数据转发至外部服务；获取外部服务生成的外部服务返回结果，并将外部服务返回结果作为请求结果返回至请求端。本申请具有提高在通过网络请求接口进行数据交换时对接口数据的处理能力的效果。效果。效果。

【技术实现步骤摘要】
一种网络请求与接口文档关联方法、系统及存储介质


[0001]本申请涉及软件开发的
，尤其是涉及一种网络请求与接口文档关联方法、系统及存储介质。

技术介绍

[0002]软件开发主要由前端页面和后端服务两部分构成，通过网络请求接口进行数据交换，而接口开发的主流方法主要有以下几种：1.在网络代理层面进行接口转发和请求修改等操作，如利用Charles等工具进行请求转发；2.在软件编码层面进行接口数据的修改，如直接在项目代码中进行修改。
[0003]上述两种方式的核心均为提供了一个代理服务进行请求转发，但这些方式只能对网络请求数据进行相应的转发、修改，但均无法对接口字段进行约定和校验，这样便无法判断后端接口是否是否按照约定的方式运行，可能导致与实际接口运行不一致的情况出现。

技术实现思路

[0004]为了提高在通过网络请求接口进行数据交换时对接口数据的处理能力，本申请提供一种网络请求与接口文档关联方法、系统及存储介质。
[0005]第一方面，本申请提供的一种网络请求与接口文档关联方法，采用如下的技术方案：一种网络请求与接口文档关联方法，包括以下步骤：编写用于对请求进行转发或修改的规则以获得若干相应的请求规则；获取请求端发出的网络请求数据；判断所述网络请求数据是否命中预设的请求规则；若命中，则查找与该请求规则所匹配的接口文档，并根据所述接口文档对所述网络请求数据进行校验以获得第一校验结果，其中，所述接口文档为预先至少约定有接口的路径、参数、字段类型、返回结构的数据信息；根据所述网络请求数据获取相应的请求结果并返回至所述请求端；若未命中，则将所述网络请求数据转发至外部服务；获取所述外部服务基于所述网络请求数据生成的外部服务返回结果，并将所述外部服务返回结果作为所述请求结果返回至所述请求端。
[0006]优选的，根据所述接口文档对所述网络请求数据进行校验以获得校验结果，包括以下步骤：判断所述网络请求数据所对应的接口路径是否满足所述接口文档所约定的接口路径；若包含，则所述第一校验结果为通过；若不包含，则所述第一校验结果为不通过；
判断所述网络请求数据内是否包含所述接口文档内约定的字段参数；若包含，则所述第一校验结果为通过；若不包含，则所述第一校验结果为不通过；判断所述网络请求数据的字段类型是否满足所述接口文档内约定的字段参数；若包含，则所述第一校验结果为通过；若不包含，则所述第一校验结果为不通过。
[0007]优选的，根据所述网络请求数据获取相应的请求结果并返回至所述请求端，包括以下步骤：获取所述网络请求数据的转发路径；根据所述转发路径判断所述网络请求数据是否转发至外部服务；若是，则将所述网络请求数据转发至外部服务；获取所述外部服务基于所述网络请求数据生成的外部服务返回结果，并将所述外部服务返回结果作为所述请求结果返回至所述请求端；若否，则根据查找出的接口文档返回相应的接口返回数据，其中，所述接口返回数据表征为所述接口文档编写后对应生成的数据；将所述接口返回数据作为请求结果返回至所述请求端。
[0008]优选的，根据所述接口返回数据和/或外部服务返回结果作为请求结果后，还包括以下步骤：判断所述请求结果是否命中预设的请求规则；若命中，则根据所述请求规则相匹配的接口文档对所述请求结果进行校验以得到第二校验结果，并在校验后将所述请求结果返回至所述请求端；若未命中，则直接将所述请求结果返回至所述请求端。
[0009]优选的，根据所述接口文档对所述网络请求数据和/或请求结果进行校验时，还包括：根据所述网络请求数据和/或请求结果及对应的校验结果生成数据展示信息，所述数据展示信息至少包括网络请求数据、请求结果、接口文档内容、各字段含义；将所述数据展示信息进行显示。
[0010]优选的，还包括以下步骤：根据自定义规则将所述接口文档同步至相应的更新维护人端口。
[0011]优选的，当获取到所述请求端发出的网络请求数据后，还包括以下步骤：判断所述网络请求数据是否能触发自定义事件，所述自定义事件包括预设的特定事件及注册各个特定事件的方法；若触发，则根据所述网络请求数据及其触发的自定义事件生成相应的定制处理指令；根据所述定制处理指定对所述网络请求数据进行定制化处理；若未触发，则继续判断所述网络请求数据是否命中预设的请求规则。
[0012]第二方面，本申请提供的一种网络请求与接口文档关联系统，采用如下的技术方案：一种网络请求与接口文档关联系统，包括请求端、网络代理模块、接口模块、外部
服务，其中，所述接口模块用于约定接口的路径、参数、字段类型、返回结构的数据信息，以生成相应的接口文档，还用于对网络请求数据的输入及输出进行校验，还用于返回所述网络请求数据的请求结果并修改；所述网络代理模块编写用于对请求进行转发或修改的规则以获得若干相应的请求规则，并获取所述请求端发出的网络请求数据并判断所述网络请求数据是否命中预设的请求规则；若命中，则所述网络代理模块查找与该请求规则所匹配的接口文档，并根据所述接口文档对所述网络请求数据进行校验以获得第一校验结果，并根据所述网络请求数据获取相应的请求结果并返回至所述请求端；若未命中，则所述网络代理模块将所述网络请求数据转发至外部服务，获取所述外部服务基于所述网络请求数据生成的外部服务返回结果，并将所述外部服务返回结果作为所述请求结果返回至所述请求端。
[0013]优选的，还包括自定义插件模块，所述自定义插件模块至少包括文档自定义同步模块和接口自定义拦截模块，其中。
[0014]所述文档自定义同步模块用于根据自定义规则将所述接口文档同步至相应的更新维护人端口；所述接口自定义拦截模块用于判断所述网络请求数据是否能触发自定义事件，所述自定义事件包括预设的特定事件及注册各个特定事件的方法；若触发，则根据所述网络请求数据及其触发的自定义事件生成相应的定制处理指令；根据所述定制处理指定对所述网络请求数据进行定制化处理；若未触发，则继续判断所述网络请求数据是否命中预设的请求规则。
[0015]第三方面，本申请提供一种计算机存储介质，采用如下的技术方案：一种计算机存储介质，其上存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现上述的网络请求与接口文档关联方法。
[0016]综上所述，本申请包括以下至少一种有益技术效果：1.通过请求规则与接口文档的一对一绑定，支持对网络请求的输入/输出的数据进行字段校验；2.在查看网络请求的数据时，能结合接口文档，实时展示接口内容、各字段含义，使请求更加清晰直观；3.接口自定义模块能极大提高开发过程中的自由度，能针对请求路径、请求参数、代码流程进行更精细化的定制。
附图说明
[0017]图1是本申请实施例的整体步骤示意图；图2是本申请实施例的整体流程示意图；图3是本申请实施例中网络请求与接口文档关联系统的示意图。
具体实施方式
[0018]以下结合附图1
‑
3对本申请作进一步详细说明。
[0019]本申请实施例公开一种网络请求与接口文档关本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种网络请求与接口文档关联方法，其特征在于，包括以下步骤：编写用于对请求进行转发或修改的规则以获得若干相应的请求规则；获取请求端发出的网络请求数据；判断所述网络请求数据是否命中预设的请求规则；若命中，则查找与该请求规则所匹配的接口文档，并根据所述接口文档对所述网络请求数据内的接口参数进行校验以获得第一校验结果，其中，所述接口文档为预先至少约定有接口的路径、参数、字段类型、返回结构的数据信息；根据所述网络请求数据获取相应的请求结果并返回至所述请求端；若未命中，则将所述网络请求数据转发至外部服务；获取所述外部服务基于所述网络请求数据生成的外部服务返回结果，并将所述外部服务返回结果作为所述请求结果返回至所述请求端。2.根据权利要求1所述的网络请求与接口文档关联方法，其特征在于：根据所述接口文档对所述网络请求数据内的接口参数进行校验以获得第一校验结果，包括以下步骤：判断所述网络请求数据的接口参数所对应的接口路径是否满足所述接口文档所约定的接口路径；若包含，则所述第一校验结果为通过；若不包含，则所述第一校验结果为不通过；判断所述网络请求数据的接口参数是否包含所述接口文档内约定的字段参数；若包含，则所述第一校验结果为通过；若不包含，则所述第一校验结果为不通过；判断所述网络请求数据的接口参数的字段类型是否满足所述接口文档内约定的字段参数；若包含，则所述第一校验结果为通过；若不包含，则所述第一校验结果为不通过。3.根据权利要求1所述的网络请求与接口文档关联方法，其特征在于：根据所述网络请求数据获取相应的请求结果并返回至所述请求端，包括以下步骤：获取所述网络请求数据的转发路径；根据所述转发路径判断所述网络请求数据是否转发至外部服务；若是，则将所述网络请求数据转发至外部服务；获取所述外部服务基于所述网络请求数据生成的外部服务返回结果，并将所述外部服务返回结果作为所述请求结果返回至所述请求端；若否，则根据查找出的接口文档返回相应的接口返回数据，其中，所述接口返回数据表征为所述接口文档编写后对应生成的数据；将所述接口返回数据作为请求结果返回至所述请求端。4.根据权利要求1所述的网络请求与接口文档关联方法，其特征在于：根据所述接口返回数据和/或外部服务返回结果作为请求结果后，还包括以下步骤：判断所述请求结果是否命中预设的请求规则；若命中，则根据所述请求规则相匹配的接口文档对所述请求结果内的接口参数进行校验以得到第二校验结果，并在校验后将所述请求结果返回至所述请求端；
若未命中，则直接将所述请求结果返回至所述请求端。5.根据权利要求1所述的网络请求与接口文档关联方法，其特征在于：根据所述接口文档对所述网络请求数据和/或请求结果内的接口...

【专利技术属性】
技术研发人员：陈文彬，
申请(专利权)人：观澜网络杭州有限公司银川丁香互联网医院有限公司杭州丁香健康管理有限公司杭州联科美讯生物医药技术有限公司，
类型：发明
国别省市：