API接口的生成方法和装置制造方法及图纸

技术编号:32466012 阅读:56 留言:0更新日期:2022-02-26 09:04
本申请公开了一种API接口的生成方法和装置。其中,该方法包括:展示可视化的WEB界面,用户在WEB界面上配置API接口的内部业务;通过XML模板接收用户对API接口的内部业务的配置;按照XML模板调用组件库中的组件,以生成满足内部业务配置的API接口,从而可以快速生成API接口,而不用手动编辑底层代码,可以解决相关技术中API接口开发效率较低的技术问题。技术中API接口开发效率较低的技术问题。技术中API接口开发效率较低的技术问题。

【技术实现步骤摘要】
API接口的生成方法和装置


[0001]本申请涉及互联网领域,具体而言,涉及一种API接口的生成方法和装置。

技术介绍

[0002]API(Application Programming Interface,应用程序接口)是一些预先定义的接口(如函数、HTTP接口),或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程,而又无需访问源码,或理解内部工作机制的细节。
[0003]操作系统是用户与计算机硬件系统之间的接口,用户通过操作系统的帮助,可以快速、有效和安全、可靠地操纵计算机系统中的各类资源,以处理自己的程序。为使用户能方便地使用操作系统,OS又向用户提供了如下两类接口:(1)用户接口:操作系统专门为用户提供了“用户与操作系统的接口”,通常称为用户接口。该接口支持用户与OS之间进行交互,即由用户向OS请求提供特定的服务,而系统则把服务的结果返回给用户。
[0004](2)程序接口:操作系统向编程人员提供了“程序与操作系统的接口”,简称程序接口,又称应用程序接口API。该接口是为程序员在编程时使用的,系统和应用程序通过这个接口,可在执行中访问系统中的资源和取得OS的服务,它也是程序能取得操作系统服务的唯一途径。大多数操作系统的程序接口是由一组系统调用(system call)组成,每一个系统调用都是一个能完成特定功能的子程序。
[0005]程序设计的实践中,编程接口的设计首先要使软件系统的职责得到合理划分,良好的接口设计可以降低系统各部分的相互依赖,提高组成单元的内聚性,降低组成单元间的耦合程度,从而提高系统的可维护性和可扩展性。
[0006]目前的API需要人工开发代码且会造成重复劳动,影响了开发效率,企业业务发生变更后,产品需要重复升级迭代,分布式部署场景下API接口不能自动更新。
[0007]针对上述的问题,目前尚未提出有效的解决方案。

技术实现思路

[0008]本申请实施例提供了一种API接口的生成方法和装置,以至少解决相关技术中API接口开发效率较低的技术问题。
[0009]根据本申请实施例的一个方面,提供了一种API接口的生成方法,包括:展示可视化的WEB界面,其中,WEB界面用于配置API接口的内部业务;通过XML模板接收用户对API接口的内部业务的配置;按照XML模板调用组件库中的组件,以生成满足内部业务配置的API接口。
[0010]可选地,在展示可视化的WEB界面之前,方法还包括:对企业业务进行分析后,对企业业务进行拆分,并根据拆分得到的业务内容创建企业业务的常用组件,其中,常用组件中包括结构化查询语言组件SQL、超文本传输协议组件HTTP、可编程WEB应用程序组件
WEBSERVICE、逻辑校验组件以及常量定义组件;为每个常用组件创建一个节点单元,并为该节点单元创建配置编辑界面,以便于用户在WEB界面中选取相应的节点单元、并通过配置编辑界面对选取的节点单元进行配置。
[0011]可选地,在为每个常用组件创建一个节点单元,并为该节点单元创建配置编辑界面之后,方法还包括:获取测试用例,其中,测试用例是预先编辑好的用于测试节点单元的用例;利用测试用例对节点单元所表示的常用组件进行测试,并根据测试结果进行优化,其中,测试过程中具有单步调试功能。
[0012]可选地,在利用测试用例对节点单元所表示的常用组件进行单步调试,并根据调试结果进行优化之后,方法还包括:在任一常用组件对应的内部内容、内部逻辑以及数据源中的至少之一发生变化的情况下,对为常用组件创建的业务代码进行更新,得到更新后的常用组件;其中,对于调用更新前的常用组件的API接口,在对为常用组件创建的业务代码进行更新得到更新后的常用组件之后,自动调用更新后的常用组件的API接口。
[0013]可选地,方法还包括:在API接口的开发阶段,采用LOG4J技术对API接口的状况进行实时监控;在API接口的部署阶段,采用LOG4J技术对API接口的调用过程和执行状况进行实时监控。
[0014]可选地,在按照XML模板调用组件库中的组件,以生成满足内部业务配置的API接口之后,方法还包括:创建携带API接口的常用组件的业务代码的SDK;在调用端本地安装SDK,以便于调用端调用API接口。
[0015]可选地,在调用端本地安装SDK,以便于调用端调用API接口之后,方法还包括:在调用端调用API接口进行数据传输的时候,采用Base64算法对传输数据进行加解密,以保证数据安全性。
[0016]根据本申请实施例的另一方面,还提供了一种API接口的生成装置,包括:展示单元,用于展示可视化的WEB界面,其中,WEB界面用于配置API接口的内部业务;配置单元,用于通过XML模板接收用户对API接口的内部业务的配置;生成单元,用于按照XML模板调用组件库中的组件,以生成满足内部业务配置的API接口。
[0017]可选地,本申请的装置还可包括:创建单元,用于在展示可视化的WEB界面之前,对企业业务进行分析后,对企业业务进行拆分,并根据拆分得到的业务内容创建企业业务的常用组件,其中,常用组件中包括结构化查询语言组件SQL、超文本传输协议组件HTTP、可编程WEB应用程序组件WEBSERVICE、逻辑校验组件以及常量定义组件;为每个常用组件创建一个节点单元,并为该节点单元创建配置编辑界面,以便于用户在WEB界面中选取相应的节点单元、并通过配置编辑界面对选取的节点单元进行配置。
[0018]可选地,创建单元还用于:在为每个常用组件创建一个节点单元,并为该节点单元创建配置编辑界面之后,获取测试用例,其中,测试用例是预先编辑好的用于测试节点单元的用例;利用测试用例对节点单元所表示的常用组件进行测试,并根据测试结果进行优化,其中,测试过程中具有单步调试功能。
[0019]可选地,创建单元还用于:在利用测试用例对节点单元所表示的常用组件进行单步调试,并根据调试结果进行优化之后,在任一常用组件对应的内部内容、内部逻辑以及数据源中的至少之一发生变化的情况下,对为常用组件创建的业务代码进行更新,得到更新后的常用组件;其中,对于调用更新前的常用组件的API接口,在对为常用组件创建的业务
代码进行更新得到更新后的常用组件之后,自动调用更新后的常用组件的API接口。
[0020]可选地,创建单元还用于:在API接口的开发阶段,采用LOG4J技术对API接口的状况进行实时监控;在API接口的部署阶段,采用LOG4J技术对API接口的调用过程和执行状况进行实时监控。
[0021]可选地,创建单元还用于:在按照XML模板调用组件库中的组件,以生成满足内部业务配置的API接口之后,创建携带API接口的常用组件的业务代码的SDK;在调用端本地安装SDK,以便于调用端调用API接口。
[0022]可选地,本申请的装置还可包括:调用单元,用于在调用端本地安装SDK,以便于调用端调用API接口之后,在调用端调用API接口进本文档来自技高网
...

【技术保护点】

【技术特征摘要】
1.一种API接口的生成方法,其特征在于,包括:展示可视化的WEB界面,其中,所述WEB界面用于配置API接口的内部业务;通过XML模板接收用户对所述API接口的内部业务的配置;按照所述XML模板调用组件库中的组件,以生成满足内部业务配置的所述API接口。2.根据权利要求1所述的方法,其特征在于,在展示可视化的WEB界面之前,所述方法还包括:对企业业务进行分析后,对企业业务进行拆分,并根据拆分得到的业务内容创建企业业务的常用组件,其中,所述常用组件中包括结构化查询语言组件SQL、超文本传输协议组件HTTP、可编程WEB应用程序组件WEBSERVICE、逻辑校验组件以及常量定义组件;为每个所述常用组件创建一个节点单元,并为该节点单元创建配置编辑界面,以便于用户在所述WEB界面中选取相应的节点单元、并通过配置编辑界面对选取的节点单元进行配置。3.根据权利要求2所述的方法,其特征在于,在为每个常用组件创建一个节点单元,并为该节点单元创建配置编辑界面之后,所述方法还包括:获取测试用例,其中,所述测试用例是预先编辑好的用于测试节点单元的用例;利用所述测试用例对所述节点单元所表示的常用组件进行测试,并根据测试结果进行优化,其中,测试过程中具有单步调试功能。4.根据权利要求3所述的方法,其特征在于,在利用所述测试用例对所述节点单元所表示的常用组件进行单步调试,并根据调试结果进行优化之后,所述方法还包括:在任一所述常用组件对应的内部内容、内部逻辑以及数据源中的至少之一发生变化的情况下,对为所述常用组件创建的业务代码进行更新,得到更新后的所述常用组件;其中,对于调用更新前的所述常用组件的所述API接口,在对为所述常用组件创建...

【专利技术属性】
技术研发人员:钱海元曾双李天将
申请(专利权)人:武汉源启科技股份有限公司
类型:发明
国别省市:

网友询问留言 已有0条评论
  • 还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。

1