本发明专利技术提供一种API调用方法及装置。API调用方法包括：获取待调用API的前端调用代码，其中，前端调用代码是预先根据与待调用API具有映射关系的方法函数的描述信息动态生成的；运行前端调用代码，以对待调用API进行调用。本发明专利技术可以解决API调用繁琐以及API变更时出现的不一致导致调用不符合预期、出错等问题，提高API调用效率。
【技术实现步骤摘要】
【专利说明】
本专利技术涉及软件
，尤其涉及一种API调用方法及装置。【
技术介绍
】传统Web开发模式存在各种问题，出现了前后端分离的需求。在前后端分离开发模式中，后端主要负责业务逻辑并向前端提供数据，前端主要负责展现逻辑和页面渲染。后端开发应用程序接口(Applicat1nProgramming Interface，API)，并基于Postman等工具整理API的功能、参数等信息，由熟悉API功能的程序员或相关技术人员在API的说明文档中记录这些信息；前端根据Postman工具的试用接口对API进行试用，并根据试用情况及API的说明文档中记载的API的功能、参数等信息手动编写用于调用该API所需的调用代码，通过该调用代码调用API。其中，每当API更新后，前端都需要重新编写对应该API的调用代码，导致API调用繁琐。另外，由于API的说明文档的更新必须人工干预，如果由于人员的疏忽，或其它原因造成在API更新后没有及时更新其说明文档，则可能导致前端没有及时更新调用代码，从而导致无法成功调用API，只有在发现调用错误后，才会更新调用代码进而成功调用API，导致API的调用效率较低。【
技术实现思路
】本专利技术的多个方面提供一种API调用方法及装置，用以API调用繁琐以及API变更时出现的不一致导致调用不符合预期、出错等问题，提高API调用效率。本专利技术的一方面，提供一种API调用方法，包括:获取待调用API的前端调用代码，其中，所述前端调用代码是预先根据与所述待调用API具有映射关系的方法函数的描述信息动态生成的；运行所述前端调用代码，以对所述待调用API进行调用。作为本专利技术的进一步改进，所述预先根据与所述待调用API具有映射关系的方法函数的描述信息动态生成所述前端调用代码，包括:利用反射机制，访问加载所述方法函数所属的类的类加载器；从所述类加载器中提取所述方法函数的描述信息；根据所述方法函数的描述信息，对预设的调用代码模板进行渲染，以生成所述前端调用代码。作为本专利技术的进一步改进，所述根据所述方法函数的描述信息，对预设的调用代码模板进行渲染，以生成所述前端调用代码之后，包括:根据检测需求，在所述前端调用代码增加符合所述检测需求的功能代码，以形成测试版本的前端调用代码；和/或对所述前端调用代码进行代码压缩，以形成发布版本的前端调用代码。作为本专利技术的进一步改进，所述从所述类加载器中提取所述方法函数的描述信息，包括:从所述类加载器中提取所述方法函数的注解信息；根据所述方法函数的注解信息，获取所述方法函数的描述信息。作为本专利技术的进一步改进，所述从所述类加载器中提取所述方法函数的描述信息之后，包括:按照预设的数据格式，对所述方法函数的描述信息进行处理，以生成所述待调用API的说明文档；输出所述待调用API的说明文档。作为本专利技术的进一步改进，所述获取待调用API的前端调用代码，包括:根据所述待调用API的说明文档，从软件开发工具包SDK中获取与所述待调用API的说明文档相匹配的前端调用代码。作为本专利技术的进一步改进，所述方法还包括:在测试用例的控制下，运行所述前端调用代码以在测试环境下模拟对所述待调用API的调用，并根据调用结果输出测试结果，以实现对所述待调用API的测试。本专利技术的另一方面，提供一种调用代码生成方法，包括:利用反射机制，访问加载与应用程序接口 API具有映射关系的方法函数所属的类的类加载器；从所述类加载器中提取所述方法函数的描述信息；根据所述方法函数的描述信息，对预设的调用代码模板进行渲染，以生成所述API的前端调用代码。本专利技术的又一方面，提供一种API调用装置，包括:获取模块，用于获取待调用API的前端调用代码，其中，所述前端调用代码是预先根据与所述待调用API具有映射关系的方法函数的描述信息动态生成的；运行模块，用于运行所述前端调用代码，以对所述待调用API进行调用。作为本专利技术的进一步改进，所述装置还包括:访问模块，用于利用反射机制，访问加载所述方法函数所属的类的类加载器；提取模块，用于从所述类加载器中提取所述方法函数的描述信息；生成模块，用于根据所述方法函数的描述信息，对预设的调用代码模板进行渲染，以生成所述前端调用代码。作为本专利技术的进一步改进，所述生成模块还用于:根据检测需求，在所述前端调用代码增加符合所述检测需求的功能代码，以形成测试版本的前端调用代码；和/或对所述前端调用代码进行代码压缩，以形成发布版本的前端调用代码。作为本专利技术的进一步改进，所述提取模块具体用于:从所述类加载器中提取所述方法函数的注解信息；根据所述方法函数的注解信息，获取所述方法函数的描述信息。作为本专利技术的进一步改进，所述装置还包括:文档处理模块，用于按照预设的数据格式，对所述方法函数的描述信息进行处理，以生成所述待调用API的说明文档；输出所述待调用API的说明文档。作为本专利技术的进一步改进，所述获取模块具体用于:根据所述待调用API的说明文档，从软件开发工具包SDK中获取与所述待调用API的说明文档相匹配的前端调用代码。作为本专利技术的进一步改进，所述装置还包括:测试模块，用于在测试用例的控制下，运行所述前端调用代码以在测试环境下模拟对所述待调用API的调用，并根据调用结果输出测试结果，以实现对所述待调用API的测试。本专利技术的又一方面，提供一种调用代码生成装置，包括:访问模块，用于利用反射机制，访问加载与应用程序接口 API具有映射关系的方法函数所属的类的类加载器；提取模块，用于从所述类加载器中提取所述方法函数的描述信息；生成模块，用于根据所述方法函数的描述信息，对预设的调用代码模板进行渲染，以生成所述API的前端调用代码。在本专利技术中，基于预先根据与待调用API具有映射关系的方法函数的描述信息动态生成的待调用API的前端调用代码，实现对待调用API的调用。其中，基于与待调用API具有映射关系的方法函数的描述信息，可以实现待调用API的前端调用代码的自动生成，尤其是在待调用API更新时，本专利技术中的前端调用代码可以自动根据待调用API对应的方法函数进行适应性更新，不需要用户手动编写API的调用代码，并且在该过程中，无需像现有技术那样人工维护API的说明文档，也就不会出现现有技术中由于人员的疏忽，或其它原因造成在API更新后没有及时更新其说明文档进而导致前端没有及时更新调用代码的问题，解决了 API调用繁琐以及API变更时出现的不一致导致调用不符合预期、出错等问题，有利于提高API调用效率。【【附图说明】】为了更清楚地说明本专利技术实施例中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作一简单地介绍，显而易见地，下面描述中的附图是本专利技术的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。图1为本专利技术一实施例提供的调用代码生成方法的流程示意图；图2为本专利技术一实施例提供的API调用方法的流程示意图；图3为本专利技术一实施例提供的API调用装置的结构示意图；图4为本专利技术另一实施例提供的API调用装置的结构示意图；图5为本专利技术一实施例提供的调用代码生成装置的结构示意图；图6为本专利技术另一实施例提供的调用代码生成装置的结构示意图；图7为本专利技术一实施例提供的调用代码本文档来自技高网...
【技术保护点】
一种应用程序接口API调用方法，其特征在于，包括：获取待调用API的前端调用代码，其中，所述前端调用代码是预先根据与所述待调用API具有映射关系的方法函数的描述信息动态生成的；运行所述前端调用代码，以对所述待调用API进行调用。
【技术特征摘要】
【专利技术属性】
技术研发人员：张振阳，
申请(专利权)人：百度在线网络技术北京有限公司，
类型：发明
国别省市：北京;11
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。