一种通过应用程序编程接口API获取数据的方法及装置制造方法及图纸

本申请公开了一种通过应用程序编程接口API获取数据的方法及装置。该方法包括：解析目标API的配置文件，所述配置文件用于配置所述目标API的属性，所述目标API的配置文件与所述目标API的运行逻辑解耦；根据所述配置文件渲染请求参数输入组件，所述请求参数输入组件携带输入提示信息；接收用户通过所述请求参数输入组件输入的请求参数的参数值；根据所述配置文件以及所述参数值获取请求数据。该方法通过在请求参数输入组件中携带有输入提示信息，进而用户可以参考该输入提示信息的内容，通过请求参数输入组件输入请求参数的参数值。该参数值是用户参考输入提示信息而输入的，因此能够降低该参数值被用户输错的情况。降低该参数值被用户输错的情况。降低该参数值被用户输错的情况。

【技术实现步骤摘要】
一种通过应用程序编程接口API获取数据的方法及装置


[0001]本申请涉及计算机
，特别是涉及一种通过应用程序编程接口API 获取数据的方法及装置。

技术介绍

[0002]在进行应用程序开发时，为了提高开发效率，用户可以针对一些功能提供对应的应用程序编程接口(application programming interface，API)。该API 可以是预先定义的函数或者应用程序的不同部分衔接的约定，通过调用API 可以使得用户无需访问数据库的源代码或者理解内部工作机制即可获得一些数据。
[0003]在一些场景中，用户可以输入请求参数的参数值给API，该API根据请求参数的参数值从数据库中获取请求数据，并返回给用户。例如：请求参数可以为手机号，用户可以输入“138 1234 5678”给API，进而获得该手机号对应的话费数据。
[0004]但是，请求参数的参数值(例如：11位的手机号码)较长时，用户可能会存在输错的情况，进而获取错误的请求数据或无法获取到请求数据。

技术实现思路

[0005]为了解决上述技术问题，本申请提供了一种通过应用程序编程接口API 获取数据的方法，该方法能够降低用户输错请求参数的参数值的情况。
[0006]本申请实施例公开了如下技术方案：
[0007]第一方面，本申请提供了一种通过应用程序编程接口API获取数据的方法，所述方法包括：
[0008]解析目标API的配置文件，所述配置文件用于配置所述目标API的属性，所述目标API的配置文件与所述目标API的运行逻辑解耦；
[0009]根据所述配置文件渲染请求参数输入组件，所述请求参数输入组件携带输入提示信息；
[0010]接收用户通过所述请求参数输入组件输入的请求参数的参数值；
[0011]根据所述配置文件以及所述参数值获取请求数据。
[0012]可选的，所述请求参数输入组件包括下拉框；所述接收用户通过所述请求参数输入组件输入的请求参数的参数值，包括：
[0013]响应于用户对所述下拉框中请求参数的参数值的选择操作，接收所述用户选择的请求参数的参数值。
[0014]可选的，所述请求参数输入组件包括输入框，所述输入框携带有所述请求参数的约束条件；所述接收用户通过所述请求参数输入组件输入的请求参数的参数值，包括：
[0015]接收用户根据所述约束条件在所述输入框中输入的所述请求参数的参数值。
[0016]可选的，所述方法还包括：
[0017]当所述用户通过所述请求参数输入组件输入的请求参数的参数值为非法值时，向
所述用户呈现反馈信息。
[0018]可选的，所述方法还包括：
[0019]接收用户针对所述配置文件的更新信息，所述更新信息用于更新所述配置文件中的地址信息或组件信息；所述地址信息用于配置所述目标API的请求地址，所述组件信息用于指示所述请求参数输入组件的类型。
[0020]可选的，所述方法还包括：
[0021]输出所述请求数据。
[0022]可选的，所述配置文件还包括输出类型信息，所述输出所述请求数据，包括：
[0023]基于所述输出类型信息，向用户呈现所述请求数据，或导出针对所述请求数据的文件。
[0024]第二方面，本申请提供了一种通过应用程序编程接口API获取数据的装置，其特征在于，包括：解析模块、渲染模块、接收模块和请求模块；
[0025]所述解析模块，用于解析目标API的配置文件，所述配置文件用于配置所述目标API的属性，所述目标API的配置文件与所述目标API的运行逻辑解耦；
[0026]所述渲染模块，用于根据所述配置文件渲染请求参数输入组件，所述请求参数输入组件携带输入提示信息；
[0027]所述接收模块，用于接收用户通过所述请求参数输入组件输入的请求参数的参数值；
[0028]所述请求模块，用于根据所述配置文件以及所述参数值获取请求数据。
[0029]可选的，所述请求参数输入组件包括下拉框；所述接收模块，具体用于响应于用户对所述下拉框中请求参数的参数值的选择操作，接收所述用户选择的请求参数的参数值。
[0030]可选的，所述请求参数输入组件包括输入框，所述输入框携带有所述请求参数的约束条件；所述接收模块，具体用于接收用户根据所述约束条件在所述输入框中输入的所述请求参数的参数值。
[0031]可选的，所述装置还包括反馈模块，所述反馈模块，用于当所述用户通过所述请求参数输入组件输入的请求参数的参数值为非法值时，向所述用户呈现反馈信息。
[0032]可选的，所述接收模块还用于接收用户针对所述配置文件的更新信息，所述更新信息用于更新所述配置文件中的地址信息或组件信息；所述地址信息用于配置所述目标API的请求地址，所述组件信息用于指示所述请求参数输入组件的类型。
[0033]可选的，所述装置还包括输出模块，所述输出模块用于输出所述请求数据。
[0034]可选的，所述配置文件还包括输出类型信息；所述输出模块，具体用于基于所述输出类型信息，向用户呈现所述请求数据，或导出针对所述请求数据的文件。
[0035]第三方面，本申请提供了一种计算设备，所述设备包括：
[0036]存储器，用于存储计算机程序，并将所述计算机程序传输给所述处理器；
[0037]处理器，用于根据所述计算机程序中的指令执行上述第一方面中任一项所述的方法。
[0038]第四方面，本申请提供了一种计算机可读存储介质，所述计算机可读存储介质用于存储计算机软件指令，当所述计算机可读存储介质在计算机上运行时，使得计算机可以执行上述第一方面中任一项所述的方法。
[0039]由上述技术方案可以看出，本申请具有以下优点：
[0040]本申请提供的一种通过应用程序编程接口API获取数据的方法。该方法通过在请求参数输入组件中携带有输入提示信息，进而用户可以参考该输入提示信息的内容，通过请求参数输入组件输入请求参数的参数值。该参数值是用户参考输入提示信息而输入的，因此能够降低该参数值被用户输错的情况。进一步的，目标API与目标API的配置文件运行逻辑解耦，即目标API 和目标API的配置文件的均单独运行，进而能够通过不同的配置文件来对目标API进行配置。当需要该目标API适应于其他项目时，仅需要对配置文件进行修改即可，进而使该目标API具有可移植性、复用性，同时降低了对目标API的维护成本。
附图说明
[0041]为了更清楚地说明本申请实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。
[0042]图1为本申请实施例提供的一种业务系统的系统架构图；
[0043]图2为本申请实施例提供的一种输入界面的本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种通过应用程序编程接口API获取数据的方法，其特征在于，所述方法包括：解析目标API的配置文件，所述配置文件用于配置所述目标API的属性，所述目标API的配置文件与所述目标API的运行逻辑解耦；根据所述配置文件渲染请求参数输入组件，所述请求参数输入组件携带输入提示信息；接收用户通过所述请求参数输入组件输入的请求参数的参数值；根据所述配置文件以及所述参数值获取请求数据。2.根据权利要求1所述的方法，其特征在于，所述请求参数输入组件包括下拉框；所述接收用户通过所述请求参数输入组件输入的请求参数的参数值，包括：响应于用户对所述下拉框中请求参数的参数值的选择操作，接收所述用户选择的请求参数的参数值。3.根据权利要求1所述的方法，其特征在于，所述请求参数输入组件包括输入框，所述输入框携带有所述请求参数的约束条件；所述接收用户通过所述请求参数输入组件输入的请求参数的参数值，包括：接收用户根据所述约束条件在所述输入框中输入的所述请求参数的参数值。4.根据权利要求1所述的方法，其特征在于，所述方法还包括：当所述用户通过所述请求参数输入组件输入的请求参数的参数值为非法值时，向所述用户呈现反馈信息。5.根据权利要求1所述的方法，其特征在于，所述方法还包括：接收用户针对所述配置文件的更新信息，所述更新信息用于更新所述配置文件中的地址信息或组件信息；所述地址信息用于配置所述目标API的请求地址，所述组件信...

【专利技术属性】
技术研发人员：李域菲，
申请(专利权)人：深圳集智数字科技有限公司，
类型：发明
国别省市：