CN111427613A - 一种应用程序接口api管理方法和装置 - Google Patents

一种应用程序接口api管理方法和装置 Download PDF

Info

Publication number
CN111427613A
CN111427613A CN202010171847.1A CN202010171847A CN111427613A CN 111427613 A CN111427613 A CN 111427613A CN 202010171847 A CN202010171847 A CN 202010171847A CN 111427613 A CN111427613 A CN 111427613A
Authority
CN
China
Prior art keywords
api
parameters
interface description
interface
description data
Prior art date
Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
Granted
Application number
CN202010171847.1A
Other languages
English (en)
Other versions
CN111427613B (zh
Inventor
汤赞
Current Assignee (The listed assignees may be inaccurate. Google has not performed a legal analysis and makes no representation or warranty as to the accuracy of the list.)
Beijing Mininglamp Software System Co ltd
Original Assignee
Beijing Mininglamp Software System Co ltd
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by Beijing Mininglamp Software System Co ltd filed Critical Beijing Mininglamp Software System Co ltd
Priority to CN202010171847.1A priority Critical patent/CN111427613B/zh
Publication of CN111427613A publication Critical patent/CN111427613A/zh
Application granted granted Critical
Publication of CN111427613B publication Critical patent/CN111427613B/zh
Active legal-status Critical Current
Anticipated expiration legal-status Critical

Links

Images

Classifications

    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F8/00Arrangements for software engineering
    • G06F8/70Software maintenance or management
    • G06F8/71Version control; Configuration management
    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F16/00Information retrieval; Database structures therefor; File system structures therefor
    • G06F16/20Information retrieval; Database structures therefor; File system structures therefor of structured data, e.g. relational data
    • G06F16/22Indexing; Data structures therefor; Storage structures
    • G06F16/2282Tablespace storage structures; Management thereof
    • GPHYSICS
    • G06COMPUTING; CALCULATING OR COUNTING
    • G06FELECTRIC DIGITAL DATA PROCESSING
    • G06F16/00Information retrieval; Database structures therefor; File system structures therefor
    • G06F16/20Information retrieval; Database structures therefor; File system structures therefor of structured data, e.g. relational data
    • G06F16/25Integrating or interfacing systems involving database management systems
    • G06F16/252Integrating or interfacing systems involving database management systems between a Database Management System and a front-end application

Landscapes

  • Engineering & Computer Science (AREA)
  • Theoretical Computer Science (AREA)
  • General Engineering & Computer Science (AREA)
  • Databases & Information Systems (AREA)
  • Software Systems (AREA)
  • Physics & Mathematics (AREA)
  • General Physics & Mathematics (AREA)
  • Data Mining & Analysis (AREA)
  • Computer Security & Cryptography (AREA)
  • Stored Programmes (AREA)
  • Computer And Data Communications (AREA)

Abstract

本发明公开了一种应用程序接口API管理方法,包括:配置所述API的接口描述数据中的一个或多个参数与API管理平台的内部字段之间的映射关系;获取所述API的接口描述数据中的一个或多个参数和对应的值,根据所配置的映射关系,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值;根据所述API管理平台中保存的内部字段的值为API的调用者提供所述API服务。本发明还公开了一种应用程序接口API管理装置。

Description

一种应用程序接口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的接口描述数据中的一个或多个参数和对应的值,根据所配置的映射关系,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值;
根据所述API管理平台中保存的内部字段的值为API的调用者提供所述API服务。
本发明实施例还提供一种应用程序接口API管理装置,包括,
配置模块,用于配置所述API的接口描述数据中的一个或多个参数与API管理平台的内部字段之间的映射关系;
映射模块,用于获取所述API的接口描述数据中的一个或多个参数和对应的值,根据所配置的映射关系,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值;
服务模块,用于根据所述API管理平台中保存的内部字段的值为API的调用者提供所述API服务。
本发明实施例还提供一种存储介质,所述存储介质中存储有计算机程序,其中,所述计算机程序被设置为运行时执行如上所述的一种应用程序接口API管理方法。
本发明实施例还提供一种电子装置,包括存储器和处理器,所述存储器中存储有计算机程序,所述处理器被设置为运行所述计算机程序以执行如上所述的一种应用程序接口API管理方法。
附图说明
图1为相关技术方案下的业务关系示意图;
图2为实施例一和二提供的一种API的管理方法的流程图;
图3为本发明方案实施后的业务关系示意图;
图4为实施例三提供的一种API的管理装置的结构图。
具体实施方式
为使本发明的目的、技术方案和优点更加清楚,下面将结合附图及具体实施例对本发明作进一步的详细描述。需要说明的是,在不冲突的情况下,本申请中的实施例及实施例中的特征可以相互任意组合。
现有技术方案中,已有一些API测试和管理工具,如Postman,Postman提供功能强大的Web API和HTTP请求的调试,它能够发送任何类型的HTTP请求(GET,POST,PUT,DELETE…),并且能附带任何数量的参数和Headers,还能提供测试数据和环境配置数据的导入和导出。Postman的API描述信息依赖人工更新,发布Postman接口描述文档。还例如Swagger,Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务,通过Swagger衍生出来的一系列项目和工具,可以做到生成各种格式的接口文档,生成多种语言的客户端和服务端的代码,以及在线接口调试页面等等。还例如,API提供者提供word文档来告知API调用者其提供的API的接口描述信息,或者通过其他沟通方式告知API调用者其提供的API的接口描述信息。对于API调用者而言,需要应对多种API接口方式和对应的接口文档,需要与API提供方保持紧密的联系,以获得最新的API相关信息。形成如图1所示的现状。
实施例一
一种API的管理方法,其流程如图2所示,包括:
步骤201:配置所述API的接口描述数据中一个或多个参数与API管理平台的内部字段之间的映射关系;
步骤202:获取所述API的接口描述数据中一个或多个参数和对应的值,根据所配置的映射关系,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值;
步骤203:根据所述API管理平台中保存的内部字段的值为API的调用者提供API服务。
可选地,所述API的接口描述数据中包括的参数有:所述API的基本调用信息参数;这些参数描述了API的基本调用信息,至少包括以下信息之一:接口服务器IP地址或域名、端口、API地址、接口协议、请求方法、请求消息头。具体的API的基本调用信息不限于本实施例所举例的内容。根据本实施例,本领域技术人员可以扩展或替换相关信息。
可选地,所述API的接口描述数据中还包括的参数有:所述API的请求参数;这些参数描述了某个具体API调用时,调用请求中需要携带的请求参数。例如,如果是用户登录请求API,则该API的请求参数至少包括以下信息:用户名、登陆密码;如果是身份证信息验证请求API,则该API的请求参数至少包括以下信息:姓名、身份证号码。根据上述举例,本领域技术人员可以知晓,根据各具体API功能的不同,对应不同的请求参数,不限于本实施例所例举的内容,本领域技术人员根据各API的功能具体定义对应的请求参数。
可选地,所述API的接口描述数据中还包括的参数有:所述API的响应参数;这些参数描述了某个具体API调用时,调用后的响应信息中包括的参数。例如,如果是用户登录请求API,则该API的响应参数至少包括以下信息之一:响应码、失败原因;如果是身份证信息验证请求API,则该API的响应参数至少包括以下信息之一:响应码、失败原因。根据上述举例,本领域技术人员可以知晓,根据各具体API功能的不同,对应不同的响应参数,不限于本实施例所例举的内容,本领域技术人员根据各API的功能具体定义对应的响应参数。
可选地,步骤201中配置所述API的接口描述数据中一个或多个参数与API管理平台的内部字段之间的映射关系,包括:根据所述API的接口描述数据,配置接口描述数据中包括的一个或多个参数与API管理平台的内部字段之间的映射关系。
再根据该映射关系,在步骤202中将接口描述数据中包括的一个或多个参数对应的参数值保存为所映射的内部字段的值。
可选地,接口描述数据中不同类型的参数的值,可以分类保存在API管理平台的内部字段表中。
可选地,当所述API的接口描述数据中包括的参数有所述API的基本调用信息参数时,所述API的基本调用信息参数保存在所述API管理平台内的API信息表中;
当所述API的接口描述数据中包括的参数有所述API的请求参数时,所述API的请求参数保存在所述API管理平台内的API请求参数表中;
当所述API的接口描述数据中包括的参数有所述API的响应参数时,所述API的响应参数保存在所述API管理平台内的API响应参数表中。
例如,以Postman导出的接口文档作为接口描述数据,具体文档如下:
Figure BDA0002409436230000051
Figure BDA0002409436230000061
Figure BDA0002409436230000071
根据该Postman导出接口文档,配置以下映射关系保存到映射表中;可选地,映射关系也可以采用其他配置形式,如配置文件,不限于本实施例例举的映射表形式。
其中,映射表结构如表1所示:
表1、映射表结构
Figure BDA0002409436230000072
针对上述Postman导出的接口文件配置的映射关系保存在上述映射表中的具体内容如下表2所示:
表2、映射表中保存的映射关系
Figure BDA0002409436230000081
上表2中,以id=1的数据说明如下:表示postman导出文档中request节点下的url节点下的raw对应API信息表的path字段,即request.url.raw节点的内容插入数据库API信息表的path字段。接口描述数据(该Postman接口描述文件)中参数request.url.raw映射为API信息表的path字段;根据这个映射关系,将接口描述数据(该Postman接口描述文件)中参数request.url.raw对应的值http://localhost:7102/rbac/users/{id},保存到API信息表的path字段。
以id=2的数据说明如下:表示postman导出文档中request节点下的url节点下的host对应API信息表的host字段,即request.url.host节点的内容插入数据库API信息表的host字段。接口描述数据(该Postman接口描述文件)中参数request.url.host映射为API信息表的host字段;根据这个映射关系,将接口描述数据(该Postman接口描述文件)中参数request.url.host对应的值localhost,保存到API信息表的host字段。
以id=3的数据说明如下:表示postman导出文档中request节点下的url节点下的port对应API信息表的port字段,即request.url.port节点的内容插入数据库API信息表的port字段;
以id=4的数据说明如下:表示postman导出文档中request节点下的method对应API信息表的method字段,即request.method节点的内容插入数据库API信息表的method字段;
以id=5的数据说明如下:表示postman导出文档中request节点下的header对应API信息表的header字段,即request.header节点的内容插入数据库API信息表的header字段;
保存后数据如表3所示:
表3、API信息表
Figure BDA0002409436230000091
上表2中,以id=6的数据说明如下:表示postman导出文档中query节点下的key对应API请求参数表的column_name字段。接口描述数据(该Postman接口描述文件)中参数query.key映射为API请求参数表的column_name字段;接口描述数据(该Postman接口描述文件)中参数query.key对应的值grant_type,根据这个映射关系,保存到API请求参数表的column_name字段。
插入数据库API请求参数表后结果如下表4所示:
表4、API请求参数表
Figure BDA0002409436230000092
可选地,插入API请求参数表时补充了column_type参数类型为字符串,comment注释字段为授权类型,parameter_type参数类型字段为query(表示这是请求字段);即不管离线还是在线导入的API接口文档都可能存在缺失部分信息,这些都可以在API管理平台再次补充。
上表2中,以id=7的数据说明如下:表示postman导出文档中response节点下的key对应API响应参数表的column_name字段;以id=8的数据说明如下:表示postman导出文档中response节点下的type对应API响应参数表的column_type字段。插入数据库API响应参数表后数据如下表5所示:
表5、API响应参数表
Figure BDA0002409436230000093
可选地,postman文档中没有对响应参数的注释comment,在API管理平台进行补充。
可以看到,通过步骤202,将Postman导出的接口描述文件中的部分参数的值,保存到由配置的映射关系(如映射关系表2)所确定的数据库表中。
可选地,步骤202中,获取所述API的接口描述数据中一个或多个参数和对应的值,包括:
读取确定格式的API的接口描述文件,根据对应的文件格式,解析所述API的接口描述文件,获得所述API的接口描述数据中一个或多个参数和对应的值;
或者,访问所述API的接口信息发布接口,获得所述API的接口描述数据中一个或多个参数和对应的值;
或者,接收所述API的接口信息发布服务器主动发布所述API的接口信息,从中获得所述API的接口描述数据中一个或多个参数和对应的值。
其中,所述确定格式的API的接口描述文件包括:Postman生成的API接口描述文件、Swagger生成的API接口描述文件、或与所述API提供方约定的其他格式的API接口描述文件。
其中,具体如何解析所述Postman生成的API的接口描述文件获得其中一个或多个参数和对应的值,本领域技术人员根据Postman相关规范定义的文件格式或方法获取即可,本发明方案不限定具体实现方式;
具体如何解析所述Swagger生成的API的接口描述文件获得其中一个或多个参数和对应的值,本领域技术人员根据Swagger相关规范定义的文件格式或方法获取即可,本发明方案不限定具体实现方式;
具体如何解析与所述API提供方约定的其他格式的API的接口描述文件获得其中一个或多个参数和对应的值,本领域技术人员根据与API提供协商定义或发布的文件格式或方法获取即可,本发明方案不限定具体实现方式。
可选地,当步骤202中采用访问所述API的接口信息发布接口而获取所述API的接口描述数据时,所述方法还包括:
在获取所述API的接口描述数据中一个或多个参数和对应的值之前,配置所述API接口信息发布接口的服务器的访问地址和访问间隔;
相应地,步骤202中将根据配置的访问间隔周期性访问所述API接口信息发布接口的服务器,获取所述API的接口描述数据,从中确定一个或多个参数和对应的值。
执行步骤202后,所述API的有关调用或测试的一个或多个参数,都根据映射关系保存在所述API管理平台中,当有被服务者需要调用所述API时,则将根据所述API管理平台中保存的内部字段的值来为API调用者提供API服务。其中,根据API管理平台中保存的内部字段的值来为调用者提供服务的具体方案不在本发明限定的范围内,可以根据被服务的一个或多个调用方的需要进一步确定。
基于本实施例的方案,所述API管理平台能够对接一个或多个API提供方,基于上述映射关系,通过离线倒入接口描述文件或在线更新接口描述文件的方式,保存API有关调用或测试的信息,统一集中地管理大量微服务对应的API接口,进而为一个或多个API调用方提供统一的API服务,大大减小了现有模式下API调用方与API提供方之间的耦合紧密度,降低了沟通协作成本,提升了通过大量微服务构建业务的能力和速度。本发明方案实施后,图1所示的业态关联变为如图3所示的业态关联。
实施例二
一种API的管理方法,其主要流程也如图2所示,包括:
步骤201:配置所述API的接口描述数据中一个或多个参数与API管理平台的内部字段之间的映射关系;
步骤202:获取所述API的接口描述数据中一个或多个参数和对应的值,根据所配置的映射关系,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值;
步骤203:根据所述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的接口描述数据中的一个或多个参数和对应的值;
访问所述API的接口信息发布接口,获得所述API的接口描述数据中的一个或多个参数和对应的值;
接收所述API的接口信息发布服务器主动发布所述API的接口信息,从中获得所述API的接口描述数据的中一个或多个参数和对应的值。
可选地,所述确定格式的API接口描述文件包括:Postman生成的API接口描述文件、Swagger生成的API接口描述文件、或与所述API提供方约定的其他格式的API接口描述文件。
可选地,当所述API的接口描述数据是通过访问所述API的接口信息发布接口获取得到时,在获取所述API的接口描述数据中的一个或多个参数和对应的值之前,所述方法还包括:
配置所述API接口信息发布接口的服务器的访问地址和访问间隔;
所述获取API的接口描述数据中的一个或多个参数和对应的值包括:
根据所述服务器的访问地址和访问间隔,访问所述API的接口信息发布接口,获得所述API的接口描述数据中的一个或多个参数和对应的值。
实施例三
一种API的管理装置40,其结构如图4,包括
配置模块401,用于配置所述API的接口描述数据中的一个或多个参数与API管理平台的内部字段之间的映射关系;
映射模块402,用于获取所述API的接口描述数据中的一个或多个参数和对应的值,根据所配置的映射关系,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值;
服务模块403,用于根据所述API管理平台中保存的内部字段的值为API的调用者提供所述API服务。
可选地,所述接口描述数据中的一个或多个参数包括:所述API的基本调用信息参数;
或者,所述接口描述数据中的一个或多个参数包括:所述API的基本调用信息参数,和至少以下之一:所述API的请求参数和所述API的响应参数。
可选地,当所述接口描述数据中包括所述API的基本调用信息参数时,所述映射模块402,设置为:将所述API的基本调用信息参数对应的值,根据配置的映射关系,保存到所述API管理平台内部的API信息表的对应字段;
可选地,当所述接口描述数据中包括所述API的请求参数时,所述映射模块402,设置为:将所述API的请求参数对应的值,根据配置的映射关系,保存到所述API管理平台内部的API请求参数表的对应字段;
可选地,当所述接口描述数据中包括所述API的响应参数时,所述映射模块402,设置为:将所述API的响应参数对应的值,根据配置的映射关系,保存到所述API管理平台内部的API响应参数表的对应字段。
可选地,所述装置还包括接口描述数据获取模块404,
所述映射模块402获取所述API的接口描述数据中的一个或多个参数和对应的值,包括以下一种或多种方式:
读取确定格式的API接口描述文件,根据对应的文件格式,解析所述API接口描述文件,获得所述API的接口描述数据中的一个或多个参数和对应的值;
调用所述接口描述数据获取模块404访问所述API的接口信息发布接口,获得所述API的接口描述数据中的一个或多个参数和对应的值;
接收所述API的接口信息发布服务器主动发布所述API的接口信息,从中获得所述API的接口描述数据的中一个或多个参数和对应的值。
可选地,所述确定格式的API接口描述文件包括:Postman生成的API接口描述文件、Swagger生成的API接口描述文件、或与所述API提供方约定的其他格式的API接口描述文件。
可选地,当所述API的接口描述数据是通过访问所述API的接口信息发布接口获取得到时,在获取所述API的接口描述数据中的一个或多个参数和对应的值之前,所述接口描述数据获取模块404还用于,配置所述API接口信息发布接口的服务器的访问地址和访问间隔;
所述接口描述数据获取模块404还用于,根据所配置的服务器的访问地址和访问间隔,访问所述API的接口信息发布接口,获得所述API的接口描述数据中的一个或多个参数和对应的值。
本发明实施例还提供一种存储介质,所述存储介质中存储有计算机程序,其中,所述计算机程序被设置为运行时执行上述任一一种应用程序接口API管理方法。
本发明实施例还提供一种电子装置,包括存储器和处理器,所述存储器中存储有计算机程序,所述处理器被设置为运行所述计算机程序以执行上述任一一种应用程序接口API管理方法。
本领域普通技术人员可以理解上述实施例的全部或部分步骤可以使用计算机程序流程来实现,所述计算机程序可以存储于一计算机可读存储介质中,所述计算机程序在相应的硬件平台上(如系统、设备、装置、器件等)执行,在执行时,包括方法实施例的步骤之一或其组合。
可选地,上述实施例的全部或部分步骤也可以使用集成电路来实现,这些步骤可以被分别制作成一个个集成电路模块,或者将它们中的多个模块或步骤制作成单个集成电路模块来实现。这样,本发明不限制于任何特定的硬件和软件结合。
上述实施例中的各装置/功能模块/功能单元可以采用通用的计算装置来实现,它们可以集中在单个的计算装置上,也可以分布在多个计算装置所组成的网络上。
上述实施例中的各装置/功能模块/功能单元以软件功能模块的形式实现并作为独立的产品销售或使用时,可以存储在一个计算机可读取存储介质中。上述提到的计算机可读取存储介质可以是只读存储器,磁盘或光盘等。
以上所述,仅为本发明的具体实施方式,但本发明的保护范围并不局限于此,任何熟悉本技术领域的技术人员在本发明揭露的技术范围内,可轻易想到变化或替换,都应涵盖在本发明的保护范围之内。因此,本发明的保护范围应以权利要求所述的保护范围为准。

Claims (10)

1.一种应用程序接口API管理方法,包括,
配置所述API的接口描述数据中的一个或多个参数与API管理平台的内部字段之间的映射关系;
获取所述API的接口描述数据中的一个或多个参数和对应的值,根据所配置的映射关系,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值;
根据所述API管理平台中保存的内部字段的值为API的调用者提供所述API服务。
2.根据权利要求1所述的方法,其中,
所述接口描述数据中的一个或多个参数包括:所述API的基本调用信息参数;
或者,所述接口描述数据中的一个或多个参数包括:所述API的基本调用信息参数,和至少以下之一:所述API的请求参数和所述API的响应参数。
3.根据权利要求2所述的方法,其中,
当所述接口描述数据中包括所述API的基本调用信息参数时,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值包括:将所述API的基本调用信息参数对应的值,根据配置的映射关系,保存到所述API管理平台内部的API信息表的对应字段;
当所述接口描述数据中包括所述API的请求参数时,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值包括:将所述API的请求参数对应的值,根据配置的映射关系,保存到所述API管理平台内部的API请求参数表的对应字段;
当所述接口描述数据中包括所述API的响应参数时,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值包括:将所述API的响应参数对应的值,根据配置的映射关系,保存到所述API管理平台内部的API响应参数表的对应字段。
4.根据权利要求1、2或3所述的方法,其中,
所述获取所述API的接口描述数据中的一个或多个参数和对应的值,包括以下一种或多种方式:
读取确定格式的API接口描述文件,根据对应的文件格式,解析所述API接口描述文件,获得所述API的接口描述数据中的一个或多个参数和对应的值;
访问所述API的接口信息发布接口,获得所述API的接口描述数据中的一个或多个参数和对应的值;
接收所述API的接口信息发布服务器主动发布所述API的接口信息,从中获得所述API的接口描述数据的中一个或多个参数和对应的值。
5.根据权利要求4所述的方法,其中,
所述确定格式的API接口描述文件包括:Postman生成的API接口描述文件、Swagger生成的API接口描述文件、或与所述API提供方约定的其他格式的API接口描述文件。
6.根据权利要求4或5所述的方法,其中,
当所述API的接口描述数据是通过访问所述API的接口信息发布接口获取得到时,在获取所述API的接口描述数据中的一个或多个参数和对应的值之前,所述方法还包括:
配置所述API接口信息发布接口的服务器的访问地址和访问间隔;
所述获取API的接口描述数据中的一个或多个参数和对应的值包括:
根据所述服务器的访问地址和访问间隔,访问所述API的接口信息发布接口,获得所述API的接口描述数据中的一个或多个参数和对应的值。
7.一种应用程序接口API管理装置,其特征在于,包括,
配置模块,用于配置所述API的接口描述数据中的一个或多个参数与API管理平台的内部字段之间的映射关系;
映射模块,用于获取所述API的接口描述数据中的一个或多个参数和对应的值,根据所配置的映射关系,将所获取的接口描述数据中的一个或多个参数对应的值保存为所述API管理平台中相应的内部字段的值;
服务模块,用于根据所述API管理平台中保存的内部字段的值为API的调用者提供所述API服务。
8.根据权利要求7所述的装置,其特征在于,
所述接口描述数据中的一个或多个参数包括:所述API的基本调用信息参数;
或者,所述接口描述数据中的一个或多个参数包括:所述API的基本调用信息参数,和至少以下之一:所述API的请求参数和所述API的响应参数。
9.一种存储介质,其特征在于,所述存储介质中存储有计算机程序,其中,所述计算机程序被设置为运行时执行所述权利要求1至6任一项中所述的方法。
10.一种电子装置,包括存储器和处理器,其特征在于,所述存储器中存储有计算机程序,所述处理器被设置为运行所述计算机程序以执行所述权利要求1至6任一项中所述的方法。
CN202010171847.1A 2020-03-12 2020-03-12 一种应用程序接口api管理方法和装置 Active CN111427613B (zh)

Priority Applications (1)

Application Number Priority Date Filing Date Title
CN202010171847.1A CN111427613B (zh) 2020-03-12 2020-03-12 一种应用程序接口api管理方法和装置

Applications Claiming Priority (1)

Application Number Priority Date Filing Date Title
CN202010171847.1A CN111427613B (zh) 2020-03-12 2020-03-12 一种应用程序接口api管理方法和装置

Publications (2)

Publication Number Publication Date
CN111427613A true CN111427613A (zh) 2020-07-17
CN111427613B CN111427613B (zh) 2023-04-28

Family

ID=71547880

Family Applications (1)

Application Number Title Priority Date Filing Date
CN202010171847.1A Active CN111427613B (zh) 2020-03-12 2020-03-12 一种应用程序接口api管理方法和装置

Country Status (1)

Country Link
CN (1) CN111427613B (zh)

Cited By (5)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN112256452A (zh) * 2020-10-21 2021-01-22 上海商汤智能科技有限公司 云服务平台的服务项确定方法、装置、设备及存储介质
CN112579124A (zh) * 2020-12-11 2021-03-30 平安普惠企业管理有限公司 应用程序接口的管理方法、装置、计算机设备和存储介质
CN112612452A (zh) * 2020-12-18 2021-04-06 华人运通(上海)云计算科技有限公司 一种api平台实现方法、装置、设备及存储介质
CN112905918A (zh) * 2021-03-06 2021-06-04 上海数依数据科技有限公司 一种数据服务汇聚引擎及其管理方法
WO2024119962A1 (zh) * 2022-12-07 2024-06-13 华为云计算技术有限公司 对api进行分析治理的方法、装置以及计算设备

Citations (5)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US20020078068A1 (en) * 2000-09-07 2002-06-20 Muralidhar Krishnaprasad Method and apparatus for flexible storage and uniform manipulation of XML data in a relational database system
US20050280540A1 (en) * 2004-06-21 2005-12-22 Gordon Muehl Accessing data tag information using database queries
US20170242673A1 (en) * 2016-02-19 2017-08-24 International Business Machines Corporation Methods and systems of generating ease of use interfaces for legacy system management facilities
CN109165039A (zh) * 2018-04-28 2019-01-08 北京数聚鑫云信息技术有限公司 一种web API的配置及执行方法、系统及介质
CN110806945A (zh) * 2019-11-05 2020-02-18 浪潮云信息技术有限公司 接口对接方法、装置和计算机可读介质

Patent Citations (5)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US20020078068A1 (en) * 2000-09-07 2002-06-20 Muralidhar Krishnaprasad Method and apparatus for flexible storage and uniform manipulation of XML data in a relational database system
US20050280540A1 (en) * 2004-06-21 2005-12-22 Gordon Muehl Accessing data tag information using database queries
US20170242673A1 (en) * 2016-02-19 2017-08-24 International Business Machines Corporation Methods and systems of generating ease of use interfaces for legacy system management facilities
CN109165039A (zh) * 2018-04-28 2019-01-08 北京数聚鑫云信息技术有限公司 一种web API的配置及执行方法、系统及介质
CN110806945A (zh) * 2019-11-05 2020-02-18 浪潮云信息技术有限公司 接口对接方法、装置和计算机可读介质

Cited By (6)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
CN112256452A (zh) * 2020-10-21 2021-01-22 上海商汤智能科技有限公司 云服务平台的服务项确定方法、装置、设备及存储介质
CN112579124A (zh) * 2020-12-11 2021-03-30 平安普惠企业管理有限公司 应用程序接口的管理方法、装置、计算机设备和存储介质
CN112612452A (zh) * 2020-12-18 2021-04-06 华人运通(上海)云计算科技有限公司 一种api平台实现方法、装置、设备及存储介质
CN112612452B (zh) * 2020-12-18 2023-11-14 华人运通(上海)云计算科技有限公司 一种api平台实现方法、装置、设备及存储介质
CN112905918A (zh) * 2021-03-06 2021-06-04 上海数依数据科技有限公司 一种数据服务汇聚引擎及其管理方法
WO2024119962A1 (zh) * 2022-12-07 2024-06-13 华为云计算技术有限公司 对api进行分析治理的方法、装置以及计算设备

Also Published As

Publication number Publication date
CN111427613B (zh) 2023-04-28

Similar Documents

Publication Publication Date Title
CN112615849B (zh) 微服务访问方法、装置、设备及存储介质
CN111427613B (zh) 一种应用程序接口api管理方法和装置
CN101711470A (zh) 一种用于在对等网络上创建共享信息列表的系统和方法
CN107870989A (zh) 网页生成方法及终端设备
CN110808868B (zh) 测试数据获取方法、装置、计算机设备及存储介质
CN100591056C (zh) 用于处理消息的方法和系统
CN110636038A (zh) 账号解析方法、装置、安全网关及系统
CN111680247B (zh) 网页字符串的本地调用方法、装置、设备及存储介质
CN117892348A (zh) 应用程序接口资产的管理方法、装置及电子设备
CN112948733B (zh) 接口维护方法、装置、计算设备以及介质
CN112783842A (zh) 一种日志收集方法和装置
CN112416875B (zh) 日志管理方法、装置、计算机设备及存储介质
KR20210000041A (ko) 로그 데이터의 실시간 분석 방법 및 그 장치
CN112000618B (zh) 集群节点的文件变动管理方法、装置、设备及存储介质
CN103326892B (zh) Web接口的操作方法及装置
CN112788077B (zh) 数据采集方法、装置、计算机设备和计算机可读存储介质
CN114115833B (zh) 协议审计代码自动生成方法及装置
CN115297066B (zh) 一种资源动态协同方法、装置、服务器及介质
CN114827197B (zh) 基于物联网的服务通信方法、装置、设备及介质
CN111163088B (zh) 消息处理方法、系统、装置及电子设备
WO2002033553A1 (en) Http request generation from xml definitions
CN116701520A (zh) 页面显示方法、装置、服务器及存储介质
CN117539528A (zh) 一种api接口文档管理方法、系统、电子设备及介质
KR20050093561A (ko) 무선 인터넷을 통한 복합 서비스 제공 시스템
CN118612062A (zh) 标识关联管理方法、系统、终端及存储介质

Legal Events

Date Code Title Description
PB01 Publication
PB01 Publication
SE01 Entry into force of request for substantive examination
SE01 Entry into force of request for substantive examination
GR01 Patent grant
GR01 Patent grant