CN112131293A - 接口管理方法、装置、终端设备及存储介质 - Google Patents
接口管理方法、装置、终端设备及存储介质 Download PDFInfo
- Publication number
- CN112131293A CN112131293A CN202010996307.7A CN202010996307A CN112131293A CN 112131293 A CN112131293 A CN 112131293A CN 202010996307 A CN202010996307 A CN 202010996307A CN 112131293 A CN112131293 A CN 112131293A
- Authority
- CN
- China
- Prior art keywords
- interface
- metadata
- parameter
- behavior
- information
- 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.)
- Pending
Links
- 238000007726 management method Methods 0.000 title claims description 85
- 230000006399 behavior Effects 0.000 claims description 138
- 238000004891 communication Methods 0.000 claims description 56
- 238000000034 method Methods 0.000 claims description 24
- 238000004590 computer program Methods 0.000 claims description 15
- 238000012545 processing Methods 0.000 claims description 5
- 238000012795 verification Methods 0.000 claims description 4
- 230000008878 coupling Effects 0.000 abstract description 7
- 238000010168 coupling process Methods 0.000 abstract description 7
- 238000005859 coupling reaction Methods 0.000 abstract description 7
- 230000003993 interaction Effects 0.000 abstract description 5
- 238000010586 diagram Methods 0.000 description 4
- 230000006870 function Effects 0.000 description 4
- 238000005516 engineering process Methods 0.000 description 3
- 230000005540 biological transmission Effects 0.000 description 2
- 230000008569 process Effects 0.000 description 2
- 238000012216 screening Methods 0.000 description 2
- 230000009286 beneficial effect Effects 0.000 description 1
- 238000012937 correction Methods 0.000 description 1
- 238000013500 data storage Methods 0.000 description 1
- 238000011161 development Methods 0.000 description 1
- 238000007667 floating Methods 0.000 description 1
- 238000012423 maintenance Methods 0.000 description 1
- 230000007246 mechanism Effects 0.000 description 1
- 238000012986 modification Methods 0.000 description 1
- 230000004048 modification Effects 0.000 description 1
- 238000006467 substitution reaction Methods 0.000 description 1
- 238000012546 transfer Methods 0.000 description 1
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F16/00—Information retrieval; Database structures therefor; File system structures therefor
- G06F16/20—Information retrieval; Database structures therefor; File system structures therefor of structured data, e.g. relational data
- G06F16/25—Integrating or interfacing systems involving database management systems
- G06F16/252—Integrating or interfacing systems involving database management systems between a Database Management System and a front-end application
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F9/00—Arrangements for program control, e.g. control units
- G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
- G06F9/44—Arrangements for executing specific programs
- G06F9/448—Execution paradigms, e.g. implementations of programming paradigms
- G06F9/4482—Procedural
Abstract
本申请适用于信息安全技术领域，提供了一种接口管理方法、装置、终端设备及存储介质，其中，通过接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据、环境元数据和通信信息元数据，由于接口元数据、参数元数据、行为元数据和环境元数据用于分别描述目标接口的接口信息、参数信息、行为信息和环境信息，因此基于获取到的接口元数据、参数元数据、行为元数据和环境元数据能生成目标接口对应的接口文档，使得无需获取应用中的接口信息，降低了与应用之间的信息交互，使得与应用之间的耦合性较低，提高了接口管理效率。本申请还涉及区块链领域，将接口文档和接口代码上传至区块链存储。
Description
技术领域
本申请涉及信息安全技术领域，尤其涉及一种接口管理方法、装置、终端设备及存储介质。
背景技术
随着计算机技术的发展，企业与外部合作方的合作越来越密切。随着合作方的数量越来越多，且由于合作方之间通过接口实现数据的通信及发布，所以相应的接口也越来越多，因此，为接口的维护工作带来了极大的困难。
现有的接口管理过程中，当需要生成接口文档或接口代码时，需要获取对应应用中的接口信息，进而使得与应用之间的耦合性较高，导致接口管理效率低下。
发明内容
有鉴于此，本申请实施例提供了一种接口管理方法、装置、终端设备及存储介质，以解决现有技术的接口管理过程中，由于与应用之间的耦合性较高，所导致的接口管理效率低下的问题。
本申请实施例的第一方面提供了一种接口管理方法，包括：
接收接口生成指令，并确定所述接口生成指令的指令类型；
若所述接口生成指令的指令类型为文档类型，则根据所述接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据和环境元数据，所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息；
根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档；
若所述接口生成指令的指令类型为代码类型，则根据所述接口生成指令在所述接口管理数据库中获取通信信息元数据、所述接口元数据和所述参数元数据，并根据所述通信信息元数据、所述接口元数据和所述参数元数据生成所述目标接口的接口代码，所述通信信息元数据用于描述所述目标接口的通信信息。
进一步地，所述根据所述接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据和环境元数据，包括：
根据所述接口生成指令中的元数据标识列表对所述接口管理数据库进行元数据查询，得到所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据，所述元数据标识列表包括所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据对应的数据标识。
进一步地，所述根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档，包括：
根据所述接口元数据中的接口名称和/或接口唯一标识确定所述目标接口；
根据所述接口元数据中的协议唯一标识和行为唯一标识确定所述目标接口的接口协议和接口行为；
根据所述参数元数据中的参数名称、数据类型、参数顺序和参数约束确定所述目标接口的接口参数；
根据所述行为元数据中的行为唯一标识确定所述接口行为的行为信息；
根据所述环境元数据中的环境唯一标识、环境名称和URL确定所述目标接口的环境信息；
根据所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息生成所述目标接口的所述接口文档。
进一步地，所述根据所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息生成所述目标接口的所述接口文档，包括：
根据所述接口唯一标识查询所述目标接口的接口文档模板；
将所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息存储至所述接口文档模板中，得到所述接口文档。
进一步地，所述根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档之后，还包括：
根据所述参数元数据获取所述目标接口的参数注解，并检测所述接口文档中的所述接口参数是否符合所述参数注解；
若所述接口文档中的所述接口参数符合所述参数注解，则所述接口文档的参数校验合格；
若所述接口文档中的所述接口参数不符合所述参数注解，则所述接口文档的参数校验不合格，针对所述接口文档发送参数错误提示。
进一步地，所述根据所述通信信息元数据、所述接口元数据和所述参数元数据生成所述目标接口的接口代码，包括
根据所述接口元数据中的接口名称和/或接口唯一标识确定所述目标接口；
根据所述参数元数据中的参数名称、数据类型、参数顺序和参数约束确定所述目标接口的接口参数；
根据所述通信信息元数据中的协议类型、协议版本和协议请求方法确定所述目标接口的接口协议；
根据所述接口参数和所述接口协议生成所述目标接口的所述接口代码。
进一步地，所述根据所述接口参数和所述接口协议生成所述目标接口的所述接口代码，包括：
根据所述接口协议对应的所述协议类型查询模板代码，并根据所述接口协议对应的所述协议请求方法查询代码组合列表，所述代码组合列表中存储有不同字段类型与对应代码组合之间的对应关系；
分别获取所述接口参数中不同参数字段的字段类型，并将所述参数字段的字段类型与所述代码组合列表进行匹配；
根据匹配到的所述代码组合对对应所述参数字段和所述模板代码进行组合，得到所述接口代码。
本申请实施例的第二方面提供了一种接口管理装置，包括：
指令接收单元，用于接收接口生成指令，并确定所述接口生成指令的指令类型；
元数据获取单元，用于若所述接口生成指令的指令类型为文档类型，则根据所述接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据和环境元数据，所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息；
接口文档生成单元，用于根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档；
接口代码生成单元，用于若所述接口生成指令的指令类型为代码类型，则根据所述接口生成指令在所述接口管理数据库中获取通信信息元数据、所述接口元数据和所述参数元数据，并根据所述通信信息元数据、所述接口元数据和所述参数元数据生成所述目标接口的接口代码，所述通信信息元数据用于描述所述目标接口的通信信息。
本申请实施例的第三方面提供了一种终端设备，包括存储器、处理器以及存储在所述存储器中并可在终端设备上运行的计算机程序，所述处理器执行所述计算机程序时实现第一方案提供的接口管理方法的各步骤。
本申请实施例的第四方面提供了一种存储介质，所述存储介质存储有计算机程序，所述计算机程序被处理器执行时实现第一方案提供的接口管理方法的各步骤。
实施本申请实施例提供的一种接口管理方法、装置、终端设备及存储介质具有以下有益效果：
本申请实施例提供的一种接口管理方法，通过接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据、环境元数据和通信信息元数据，由于所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息，因此基于获取到的接口元数据、参数元数据、行为元数据和环境元数据能生成目标接口对应的接口文档。由于通信信息元数据用于描述所述目标接口的通信信息，因此基于获取到的通信信息元数据能生成目标接口的接口代码，使得无需获取应用中的接口信息，降低了与应用之间的信息交互，进而使得与应用之间的耦合性较低，提高了接口管理效率。通过基于同一接口管理数据库生成的接口文档与接口代码之间信息的一致性较高，进而提高了接口管理的准确性，通过基于不同指令类型的接口生成指令，使得用户能根据需求进行接口文档和接口代码的生成，提高了接口管理的灵活性。
附图说明
为了更清楚地说明本申请实施例中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。
图1是本申请实施例提供的一种接口管理方法的实现流程图；
图2是本申请另一实施例提供的一种接口管理方法的实现流程图；
图3是本申请再一实施例提供的一种接口管理方法的实现流程图；
图4是本申请实施例提供的一种接口管理装置的结构框图；
图5是本申请实施例提供的一种终端设备的结构框图。
具体实施方式
为了使本申请的目的、技术方案及优点更加清楚明白，以下结合附图及实施例，对本申请进行进一步详细说明。应当理解，此处所描述的具体实施例仅仅用以解释本申请，并不用于限定本申请。
本申请实施例所涉及的接口管理方法，可以由控制设备或终端(以下称“移动终端”)执行。
请参阅图1，图1示出了本申请实施例提供的一种接口管理方法的实现流程图，包括：
步骤S10，接收接口生成指令，并确定所述接口生成指令的指令类型。
其中，该接口生成指令可以采用语音指令、触控指令或无线信号指令的方式进行传输，该接口生成指令中预先设置有类型标识位，该类型标识位用于表征该接口生成指令的指令类型，该类型标识位中的类型标识可以采用文字标识、数字标识、图像标识或电平信号标识。
例如，当该接口生成指令采用语音指令的方式进行传输时，则该类型标识位中的类型标识为文字标识，该步骤中，对接收到的接口生成指令进行语音识别，得到语音文本，获取该语音文本中类型标识位中的文字标识，若该语音文本中的文字标识为文字“文档”，则该接口生成指令的指令类型为文档类型，若该语音文本中的文字标识为文字“代码”，则该接口生成指令的指令类型为代码类型。
可选的，该步骤中，针对该接口生成指令可以形式化的表示为：指令唯一标识、指令名称、指令参数集合和指令注释，该指令唯一标识用于唯一识别一条接口生成指令，该指令名称用于采用符号的形式描述一条接口生成指令，该指令参数集合包括至少一个指令参数，该指令参数包括类型标识或用户标识等信息，该用户标识用于表征该接口生成指令的发送端地址。
步骤S20，若所述接口生成指令的指令类型为文档类型，则根据所述接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据和环境元数据。
其中，该接口元数据、参数元数据、行为元数据和环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息，若接口生成指令的指令类型为文档类型，则判定用户针对目标接口需要生成接口文档。
具体的，该步骤中，通过根据接口生成指令中的元数据标识列表对接口管理数据库进行元数据查询，得到该接口元数据、参数元数据、行为元数据和环境元数据，该元数据标识列表包括接口元数据、参数元数据、行为元数据和环境元数据对应的数据标识。
可选的，该步骤中，针对该接口元数据可以形式化的表示为：接口名称、接口唯一标识、协议唯一标识、行为唯一标识和环境列表，该协议唯一标识用于表征对应的通信协议，该行为唯一标识用于表征对应的接口行为信息，该环境列表用于表征对应的环境信息。
针对该参数元数据可以形式化的表示为：参数名称、数据类型、参数顺序、参数约束和参数描述，具体的，该参数名称用于描述针对目标接口设置的用户名符号，该数据类型用于描述参数允许值的数据单元，常见的数据类型有：整型、浮点型、布尔类型等，该参数顺序用于描述不同接口参数在接口文档中出现的顺序，该参数约束用于描述接口参数的取值约束，例如，针对每一天中的24小时，第8个小时至第9个小时内接口参数取值的范围为0～24，该参数描述用于对接口参数含义进行解释，如描述接口参数userName表示的含义是用户名而不是其它含义。
针对该行为元数据可以形式化的表示为：行为名称、行为唯一标识(输入，消息唯一标识)，OPTION(输出，消息唯一标识)，其中，该行为名称用于描述接口行为的含义，该行为唯一标识用于唯一描述对应的行为信息，该OPTION(输出，消息唯一标识)用于描述目标接口执行输入后得到的结果，在部分接口中可以只有输入没有输出，即接口是单项传输的，因此，针对单项传输的接口可以不设置OPTION。
针对该环境元数据可以形式化的表示为：环境名称、环境唯一标识、URL(UniformResource Locator，统一资源定位器)，其中，该环境名称用于表征针对目标接口设置的环境的名称，该环境唯一标识表征对应唯一的环境信息，该URL用于表征目标接口的环境资源定位符，例如，该URL是http资源时，则该URL表征的环境资源定位符为：http://www.xxx.xxx。
步骤S30，根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档。
其中，根据该接口元数据以确定该目标接口、目标接口的接口协议和接口行为，根据该参数元数据确定该目标接口的接口参数，根据该行为元数据确定该目标接口的行为信息，根据该环境元数据确定该目标接口的环境信息，并根据该接口协议、接口行为、接口参数、行为信息和环境信息生成目标接口的接口文档。
步骤S40，若所述接口生成指令的指令类型为代码类型，则根据所述接口生成指令在所述接口管理数据库中获取通信信息元数据、所述接口元数据和所述参数元数据，并根据所述通信信息元数据、所述接口元数据和所述参数元数据生成所述目标接口的接口代码。
其中，若接口生成指令的指令类型为代码类型，则判定用户针对目标接口需要生成接口代码，该步骤中，该通信信息元数据用于描述目标接口的通信信息。
可选的，该步骤中，针对该通信信息元数据可以形式化的表示为：协议唯一标识、协议名称、协议版本和协议请求方法，该协议名称用于描述协议的标准化名称，基于该标准化名称能有效的查询到对应的协议类型，例如，超文本传输协议的名称为http，消息队列遥测传输协议的名称是mqtt，协议版本用于描述协议的版本号，http协议的版本号有1.1、1.2和2.0等，该协议请求方法用于表征对应通信协议中规定的通信请求方法。
本实施例中，通过接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据、环境元数据和通信信息元数据，由于所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息，因此基于获取到的接口元数据、参数元数据、行为元数据和环境元数据能生成目标接口对应的接口文档。由于通信信息元数据用于描述所述目标接口的通信信息，因此基于获取到的通信信息元数据能生成目标接口的接口代码，使得无需获取应用中的接口信息，降低了与应用之间的信息交互，进而使得与应用之间的耦合性较低，提高了接口管理效率。通过基于同一接口管理数据库生成的接口文档与接口代码之间信息的一致性较高，进而提高了接口管理的准确性，通过基于不同指令类型的接口生成指令，使得用户能根据需求进行接口文档和接口代码的生成，提高了接口管理的灵活性。
请参阅图2，图2是本申请另一实施例提供的一种接口管理方法的实现流程图。相对于图1对应的实施例，本实施例提供的接口管理方法是对图1对应的实施例中步骤S30的进一步细化，包括：
S31，根据所述接口元数据中的接口名称和/或接口唯一标识确定所述目标接口。
其中，该接口管理数据库中预存储有接口查询表，该接口查询表中存储有不同接口名称和/或接口唯一标识与对应的目标接口之间的对应关系，因此，将该接口名称和/或接口唯一标识与接口查询表进行匹配，以确定对应的目标接口。
S32，根据所述接口元数据中的协议唯一标识和行为唯一标识确定所述目标接口的接口协议和接口行为。
其中，该接口管理数据库中预存储有协议查询表和行为查询表，该协议查询表中存储有不同协议唯一标识与对应接口协议之间的对应关系，该行为查询表中存储有不同行为唯一标识与对应接口行为之间的对应关系。
因此，该步骤中，将该接口元数据中的协议唯一标识与协议查询表进行匹配，得到该目标接口对应的接口协议，将该接口元数据中的行为唯一标识与行为查询表进行匹配，得到该目标接口对应的接口行为。
S33，根据所述参数元数据中的参数名称、数据类型、参数顺序和参数约束确定所述目标接口的接口参数。
其中，该接口管理数据库中预存储有参数信息查询表，该参数信息查询表中存储有不同参数名称与对应参数信息之间的对应关系，因此，将该参数元数据中的参数名称与参数信息查询表进行匹配，以查询该目标接口对应的参数信息。
该步骤中，该参数信息中存储有不同数据类型对应的信息，因此，基于该数据类型对该参数信息进行信息筛选，根据该参数顺序对信息筛选后的参数信息中的参数进行排序，并基于参数约束对参数排序后的参数信息进行参数值修正，以得到该目标接口的接口参数。
S34，根据所述行为元数据中的行为唯一标识确定所述接口行为的行为信息。
其中，该接口管理数据库中预存储有行为信息查询表，该行为信息查询表中存储有不同行为唯一标识与对应行为信息之间的对应关系，因此，将该行为元数据中的行为唯一标识与该行为信息查询表进行匹配，得到该接口行为对应的行为信息。
S35，根据所述环境元数据中的环境唯一标识、环境名称和URL确定所述目标接口的环境信息。
其中，该接口管理数据库中预存储有环境信息查询表，该环境信息查询表中存储有不同环境唯一标识、环境名称和URL与对应环境信息之间的对应关系，因此，将该环境元数据中的环境唯一标识、环境名称和URL与该环境信息查询表进行匹配，得到该目标接口的环境信息。
S36，根据所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息生成所述目标接口的所述接口文档。
具体的，该步骤中，所述根据所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息生成所述目标接口的所述接口文档，包括：
根据所述接口唯一标识查询所述目标接口的接口文档模板；
将所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息存储至所述接口文档模板中，得到所述接口文档。
此外，本实施例中，所述根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档之后，还包括：
根据所述参数元数据获取所述目标接口的参数注解，并检测所述接口文档中的所述接口参数是否符合所述参数注解；
其中，通过检测接口文档中的接口参数是否符合参数注解，以判定生成的接口文档中的参数是否准确。
若所述接口文档中的所述接口参数符合所述参数注解，则所述接口文档的参数校验合格。
进一步，可将所述接口文档传输至区块链中，进而防止了对该接口文档的数据篡改。
若所述接口文档中的所述接口参数不符合所述参数注解，则所述接口文档的参数校验不合格，针对所述接口文档发送参数错误提示。
本实施例中，通过接口元数据中的接口名称和/或接口唯一标识能有效确定目标接口，通过接口元数据中的协议唯一标识和行为唯一标识能有效确定目标接口的接口协议和接口行为，通过参数元数据中的参数名称、数据类型、参数顺序和参数约束能有效确定目标接口的接口参数，通过行为元数据中的行为唯一标识能有效确定接口行为的行为信息，通过环境元数据中的环境唯一标识、环境名称和URL能有效确定目标接口的环境信息，通过根据接口协议、接口行为、接口参数、行为信息和环境信息，以生成目标接口的接口文档，使得接口文档的生成无需与应用进行信息交互，降低了与应用之间的耦合性，提高了接口管理效率。
请参阅图3，图3是本申请另一实施例提供的一种接口管理方法的实现流程图。相对于图1对应的实施例，本实施例提供的接口管理方法是对图1对应的实施例中步骤S40的进一步细化，包括：
步骤S41，根据所述接口生成指令中的通信信息标识对所述接口管理数据库进行元数据查询，得到所述通信信息元数据。
其中，该元数据标识列表中还存储有通信信息标识，将该通信信息标识对接口管理数据库进行元数据查询，得到该通信信息元数据。
步骤S42，根据所述接口元数据中的接口名称和/或接口唯一标识确定所述目标接口。
步骤S43，根据所述参数元数据中的参数名称、数据类型、参数顺序和参数约束确定所述目标接口的接口参数。
步骤S44，根据所述通信信息元数据中的协议类型、协议版本和协议请求方法确定所述目标接口的接口协议。
步骤S45，根据所述接口参数和所述接口协议生成所述目标接口的所述接口代码。
具体的，该步骤中，所述根据所述接口参数和所述接口协议生成所述目标接口的所述接口代码，包括：
根据所述接口协议对应的所述协议类型查询模板代码，并根据所述接口协议对应的所述协议请求方法查询代码组合列表；
分别获取所述接口参数中不同参数字段的字段类型，并将所述参数字段的字段类型与所述代码组合列表进行匹配；
根据匹配到的所述代码组合对对应所述参数字段和所述模板代码进行组合，得到所述接口代码。
其中，该接口管理数据库中预存储有模板代码查询表，该模板代码查询表中存储有不同协议类型与对应模板代码之间的对应关系，因此，将该接口协议对应的协议类型与模板代码查询表进行匹配，以得到该接口协议对应的模板代码。
具体的，该代码组合列表中存储有不同字段类型与对应代码组合之间的对应关系，即不同字段类型对应的代码组合可以不相同，进而提高了后续不同字段类型信息识别的准确性，通过分别获取接口参数中不同参数字段的字段类型，并将参数字段的字段类型与代码组合列表进行匹配，有效的提高了后续参数字段与模板代码之间组合的准确性。
此外，本实施例中，所述根据所述接口参数和所述接口协议生成所述目标接口的所述接口代码之后，还包括：根据预设代码运行程序运行该接口代码，若该接口代码运行失败，则针对该接口代码发送错误提示。
本实施例中，用户仅需要对接口元数据、参数元数据、通信信息元数据中的协议类型、协议版本和协议请求方法进行设置，能自动生成对应的接口代码，提高了接口代码生成效率，且本实施例统一了接口代码与接口文档之间接口元数据、参数元数据和通信信息元数据的数据结构，形成规范和约定俗成，防止了接口代码和接口文档之间信息的不一致，提高了接口数据信息的一致性，进而提高了接口管理的准确性。
在本申请的所有实施例中，基于接口元数据、参数元数据、行为元数据和环境元数据生成目标接口的接口文档，基于通信信息元数据生成目标接口的接口代码。将接口文档和接口代码上传至区块链可保证其安全性和对用户的公正透明性。用户设备可以从区块链中下载得该接口文档和接口代码，以便查证接口文档和接口代码是否被篡改。本示例所指区块链是分布式数据存储、点对点传输、共识机制、加密算法等计算机技术的新型应用模式。区块链(Blockchain)，本质上是一个去中心化的数据库，是一串使用密码学方法相关联产生的数据块，每一个数据块中包含了一批次网络交易的信息，用于验证其信息的有效性(防伪)和生成下一个区块。区块链可以包括区块链底层平台、平台产品服务层以及应用服务层等。
请参阅图4，图4是本申请实施例提供的一种接口管理装置100的结构框图。本实施例中该接口管理装置100包括的各单元用于执行图1至图3对应的实施例中的各步骤。具体请参阅图1至图3以及图1至图3所对应的实施例中的相关描述。为了便于说明，仅示出了与本实施例相关的部分。参见图4，接口管理装置100包括：指令接收单元10、元数据获取单元11、接口文档生成单元12和接口代码生成单元13，其中：
指令接收单元10，用于接收接口生成指令，并确定所述接口生成指令的指令类型。
元数据获取单元11，用于若所述接口生成指令的指令类型为文档类型，则根据所述接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据和环境元数据，所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息。
其中，所述元数据获取单元11还用于：根据所述接口生成指令中的元数据标识列表对所述接口管理数据库进行元数据查询，得到所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据，所述元数据标识列表包括所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据对应的数据标识。
接口文档生成单元12，用于根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档。
其中，所述接口文档生成单元12还用于：根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档，包括：
根据所述接口元数据中的接口名称和/或接口唯一标识确定所述目标接口；
根据所述接口元数据中的协议唯一标识和行为唯一标识确定所述目标接口的接口协议和接口行为；
根据所述参数元数据中的参数名称、数据类型、参数顺序和参数约束确定所述目标接口的接口参数；
根据所述行为元数据中的行为唯一标识确定所述接口行为的行为信息；
根据所述环境元数据中的环境唯一标识、环境名称和URL确定所述目标接口的环境信息；
根据所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息生成所述目标接口的所述接口文档。
可选的，所述接口文档生成单元12还用于：根据所述接口唯一标识查询所述目标接口的接口文档模板；
将所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息存储至所述接口文档模板中，得到所述接口文档。
可选的，所述接口文档生成单元12还用于：根据所述参数元数据获取所述目标接口的参数注解，并检测所述接口文档中的所述接口参数是否符合所述参数注解；
若所述接口文档中的所述接口参数符合所述参数注解，则所述接口文档的参数校验合格；进一步，可将所述接口文档传输至区块链中，进而防止了对该接口文档的数据篡改。
若所述接口文档中的所述接口参数不符合所述参数注解，则所述接口文档的参数校验不合格，针对所述接口文档发送参数错误提示。
接口代码生成单元13，用于若所述接口生成指令的指令类型为代码类型，则根据所述接口生成指令在所述接口管理数据库中获取通信信息元数据、所述接口元数据和所述参数元数据，并根据所述通信信息元数据、所述接口元数据和所述参数元数据生成所述目标接口的接口代码，所述通信信息元数据用于描述所述目标接口的通信信息。
其中，所述接口代码生成单元13还用于：根据所述接口生成指令中的通信信息标识对所述接口管理数据库进行元数据查询，得到所述通信信息元数据；
根据所述接口元数据中的接口名称和/或接口唯一标识确定所述目标接口；
根据所述参数元数据中的参数名称、数据类型、参数顺序和参数约束确定所述目标接口的接口参数；
根据所述通信信息元数据中的协议类型、协议版本和协议请求方法确定所述目标接口的接口协议；
根据所述接口参数和所述接口协议生成所述目标接口的所述接口代码。
可选的，所述接口代码生成单元13还用于：根据所述接口协议对应的所述协议类型查询模板代码，并根据所述接口协议对应的所述协议请求方法查询代码组合列表，所述代码组合列表中存储有不同字段类型与对应代码组合之间的对应关系；
分别获取所述接口参数中不同参数字段的字段类型，并将所述参数字段的字段类型与所述代码组合列表进行匹配；
根据匹配到的所述代码组合对对应所述参数字段和所述模板代码进行组合，得到所述接口代码。
以上可以看出，通过接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据、环境元数据和通信信息元数据，由于所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息，因此基于获取到的接口元数据、参数元数据、行为元数据和环境元数据能生成目标接口对应的接口文档。由于通信信息元数据用于描述所述目标接口的通信信息，因此基于获取到的通信信息元数据能生成目标接口的接口代码，使得无需获取应用中的接口信息，降低了与应用之间的信息交互，进而使得与应用之间的耦合性较低，提高了接口管理效率。通过基于同一接口管理数据库生成的接口文档与接口代码之间信息的一致性较高，进而提高了接口管理的准确性，通过基于不同指令类型的接口生成指令，使得用户能根据需求进行接口文档和接口代码的生成，提高了接口管理的灵活性。
图5是本申请另一实施例提供的一种终端设备2的结构框图。如图5所示，该实施例的终端设备2包括：处理器20、存储器21以及存储在所述存储器21中并可在所述处理器20上运行的计算机程序22，例如接口管理方法的程序。处理器20执行所述计算机程序23时实现上述各个接口管理方法各实施例中的步骤，例如图1所示的S10至S40，或者图2所示的S31至S36，或者图3所示的S41至S45。或者，所述处理器20执行所述计算机程序22时实现上述图4对应的实施例中各单元的功能，例如，图4所示的单元10至13的功能，具体请参阅图5对应的实施例中的相关描述，此处不赘述。
示例性的，所述计算机程序22可以被分割成一个或多个单元，所述一个或者多个单元被存储在所述存储器21中，并由所述处理器20执行，以完成本申请。所述一个或多个单元可以是能够完成特定功能的一系列计算机程序指令段，该指令段用于描述所述计算机程序22在所述终端设备2中的执行过程。例如，所述计算机程序22可以被分割成指令接收单元10、元数据获取单元11、接口文档生成单元12和接口代码生成单元13，各单元具体功能如上所述。
所述终端设备可包括，但不仅限于，处理器20、存储器21。本领域技术人员可以理解，图5仅仅是终端设备2的示例，并不构成对终端设备2的限定，可以包括比图示更多或更少的部件，或者组合某些部件，或者不同的部件，例如所述终端设备还可以包括输入输出设备、网络接入设备、总线等。
所称处理器20可以是中央处理单元(Central Processing Unit，CPU)，还可以是其他通用处理器、数字信号处理器(Digital Signal Processor，DSP)、专用集成电路(Application Specific Integrated Circuit，ASIC)、现成可编程门阵列(Field-Programmable Gate Array，FPGA)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件等。通用处理器可以是微处理器或者该处理器也可以是任何常规的处理器等。
所述存储器21可以是所述终端设备2的内部存储单元，例如终端设备2的硬盘或内存。所述存储器21也可以是所述终端设备2的外部存储设备，例如所述终端设备2上配备的插接式硬盘，智能存储卡(Smart Media Card，SMC)，安全数字(Secure Digital，SD)卡，闪存卡(Flash Card)等。进一步地，所述存储器21还可以既包括所述终端设备2的内部存储单元也包括外部存储设备。所述存储器21用于存储所述计算机程序以及所述终端设备所需的其他程序和数据。所述存储器21还可以用于暂时地存储已经输出或者将要输出的数据。
以上所述实施例仅用以说明本申请的技术方案，而非对其限制；尽管参照前述实施例对本申请进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本申请各实施例技术方案的精神和范围，均应包含在本申请的保护范围之内。
Claims (10)
1.一种接口管理方法，其特征在于，包括：
接收接口生成指令，并确定所述接口生成指令的指令类型；
若所述接口生成指令的指令类型为文档类型，则根据所述接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据和环境元数据，所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息；
根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档；
若所述接口生成指令的指令类型为代码类型，则根据所述接口生成指令在所述接口管理数据库中获取通信信息元数据、所述接口元数据和所述参数元数据，并根据所述通信信息元数据、所述接口元数据和所述参数元数据生成所述目标接口的接口代码，所述通信信息元数据用于描述所述目标接口的通信信息。
2.根据权利要求1所述的接口管理方法，其特征在于，所述根据所述接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据和环境元数据，包括：
根据所述接口生成指令中的元数据标识列表对所述接口管理数据库进行元数据查询，得到所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据，所述元数据标识列表包括所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据对应的数据标识。
3.根据权利要求1所述的接口管理方法，其特征在于，所述根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档，包括：
根据所述接口元数据中的接口名称和/或接口唯一标识确定所述目标接口；
根据所述接口元数据中的协议唯一标识和行为唯一标识确定所述目标接口的接口协议和接口行为；
根据所述参数元数据中的参数名称、数据类型、参数顺序和参数约束确定所述目标接口的接口参数；
根据所述行为元数据中的行为唯一标识确定所述接口行为的行为信息；
根据所述环境元数据中的环境唯一标识、环境名称和URL确定所述目标接口的环境信息；
根据所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息生成所述目标接口的所述接口文档。
4.根据权利要求3所述的接口管理方法，其特征在于，所述根据所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息生成所述目标接口的所述接口文档，包括：
根据所述接口唯一标识查询所述目标接口的接口文档模板；
将所述接口协议、所述接口行为、所述接口参数、所述行为信息和所述环境信息存储至所述接口文档模板中，得到所述接口文档。
5.根据权利要求3所述的接口管理方法，其特征在于，所述根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档之后，还包括：
根据所述参数元数据获取所述目标接口的参数注解，并检测所述接口文档中的所述接口参数是否符合所述参数注解；
若所述接口文档中的所述接口参数符合所述参数注解，则所述接口文档的参数校验合格；
若所述接口文档中的所述接口参数不符合所述参数注解，则所述接口文档的参数校验不合格，针对所述接口文档发送参数错误提示。
6.根据权利要求1所述的接口管理方法，其特征在于，所述根据所述通信信息元数据、所述接口元数据和所述参数元数据生成所述目标接口的接口代码，包括：
根据所述接口元数据中的接口名称和/或接口唯一标识确定所述目标接口；
根据所述参数元数据中的参数名称、数据类型、参数顺序和参数约束确定所述目标接口的接口参数；
根据所述通信信息元数据中的协议类型、协议版本和协议请求方法确定所述目标接口的接口协议；
根据所述接口参数和所述接口协议生成所述目标接口的所述接口代码。
7.根据权利要求6所述的接口管理方法，其特征在于，所述根据所述接口参数和所述接口协议生成所述目标接口的所述接口代码，包括：
根据所述接口协议对应的所述协议类型查询模板代码，并根据所述接口协议对应的所述协议请求方法查询代码组合列表，所述代码组合列表中存储有不同字段类型与对应代码组合之间的对应关系；
分别获取所述接口参数中不同参数字段的字段类型，并将所述参数字段的字段类型与所述代码组合列表进行匹配；
根据匹配到的所述代码组合对对应所述参数字段和所述模板代码进行组合，得到所述接口代码。
8.一种接口管理装置，其特征在于，包括：
指令接收单元，用于接收接口生成指令，并确定所述接口生成指令的指令类型；
元数据获取单元，用于若所述接口生成指令的指令类型为文档类型，则根据所述接口生成指令在接口管理数据库中获取接口元数据、参数元数据、行为元数据和环境元数据，所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据分别用于描述目标接口的接口信息、参数信息、行为信息和环境信息；
接口文档生成单元，用于根据所述接口元数据、所述参数元数据、所述行为元数据和所述环境元数据生成所述目标接口的接口文档；
接口代码生成单元，用于若所述接口生成指令的指令类型为代码类型，则根据所述接口生成指令在所述接口管理数据库中获取通信信息元数据、所述接口元数据和所述参数元数据，并根据所述通信信息元数据、所述接口元数据和所述参数元数据生成所述目标接口的接口代码，所述通信信息元数据用于描述所述目标接口的通信信息。
9.一种终端设备，包括存储器、处理器以及存储在所述存储器中并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如权利要求1至7任一项所述方法的步骤。
10.一种存储介质，所述存储介质存储有计算机程序，其特征在于，所述计算机程序被处理器执行时实现如权利要求1至7任一项所述方法的步骤。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202010996307.7A CN112131293A (zh) | 2020-09-21 | 2020-09-21 | 接口管理方法、装置、终端设备及存储介质 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202010996307.7A CN112131293A (zh) | 2020-09-21 | 2020-09-21 | 接口管理方法、装置、终端设备及存储介质 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN112131293A true CN112131293A (zh) | 2020-12-25 |
Family
ID=73842313
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202010996307.7A Pending CN112131293A (zh) | 2020-09-21 | 2020-09-21 | 接口管理方法、装置、终端设备及存储介质 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN112131293A (zh) |
Citations (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20140019887A1 (en) * | 2012-07-13 | 2014-01-16 | International Business Machines Corporation | Method of encapsulating diverse user interface components while consistently enforcing external constraints |
| CN110309099A (zh) * | 2019-06-28 | 2019-10-08 | 深圳前海微众银行股份有限公司 | 接口管理方法、装置、设备及计算机可读存储介质 |
| CN110308930A (zh) * | 2019-06-18 | 2019-10-08 | 广州华多网络科技有限公司 | 接口文档生成方法、装置、计算机设备和存储介质 |
| CN110806863A (zh) * | 2019-11-05 | 2020-02-18 | 泰康保险集团股份有限公司 | 接口文档生成方法及装置、电子设备、存储介质 |
| CN110955416A (zh) * | 2019-10-12 | 2020-04-03 | 平安普惠企业管理有限公司 | 接口文档生成方法、装置、设备和计算机存储介质 |
-
2020
- 2020-09-21 CN CN202010996307.7A patent/CN112131293A/zh active Pending
Patent Citations (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20140019887A1 (en) * | 2012-07-13 | 2014-01-16 | International Business Machines Corporation | Method of encapsulating diverse user interface components while consistently enforcing external constraints |
| CN110308930A (zh) * | 2019-06-18 | 2019-10-08 | 广州华多网络科技有限公司 | 接口文档生成方法、装置、计算机设备和存储介质 |
| CN110309099A (zh) * | 2019-06-28 | 2019-10-08 | 深圳前海微众银行股份有限公司 | 接口管理方法、装置、设备及计算机可读存储介质 |
| CN110955416A (zh) * | 2019-10-12 | 2020-04-03 | 平安普惠企业管理有限公司 | 接口文档生成方法、装置、设备和计算机存储介质 |
| CN110806863A (zh) * | 2019-11-05 | 2020-02-18 | 泰康保险集团股份有限公司 | 接口文档生成方法及装置、电子设备、存储介质 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| US10454906B1 (en) | Systems and methods for encryption and authentication | |
| CN107992759B (zh) | 实现电子印章的装置、方法及计算机可读存储介质 | |
| CN111314172B (zh) | 基于区块链的数据处理方法、装置、设备及存储介质 | |
| CN101436927B (zh) | 用于文件传输管理的系统和方法 | |
| CN112367164B (zh) | 业务请求处理方法、装置、计算机设备和存储介质 | |
| CN103890734A (zh) | 遥测文件散列和冲突检测 | |
| CN109902493B (zh) | 脚本的下发方法及服务器 | |
| CN105162604A (zh) | 一种基于特征图像识别的验证方法、服务器及系统 | |
| CN110599180A (zh) | 一种基于区块链的疫苗流通管理方法及装置 | |
| WO2021078139A1 (en) | A blockchain based hybrid system and method thereof for construction document management | |
| US20100223469A1 (en) | Method, System and Computer Program Product for Certifying Software Origination | |
| CN113055380A (zh) | 报文处理方法、装置、电子设备及介质 | |
| CN113438134A (zh) | 请求报文处理方法、装置、服务器及介质 | |
| CN110458184B (zh) | 光学字符识别辅助方法、装置、计算机设备及存储介质 | |
| CN113221154A (zh) | 服务密码获取方法、装置、电子设备及存储介质 | |
| US20230095939A1 (en) | Signature Token System | |
| CN112131293A (zh) | 接口管理方法、装置、终端设备及存储介质 | |
| CN111324914B (zh) | 文件的传输方法、装置、服务器、设备和介质 | |
| CN112686759A (zh) | 对账监测方法、装置、设备及介质 | |
| CN112559546A (zh) | 数据库同步方法、装置、计算机设备及可读存储介质 | |
| CN113127109A (zh) | 接口调用方法、装置、电子设备及可读存储介质 | |
| CN115276889A (zh) | 解码处理方法、装置、计算机设备及存储介质 | |
| CN112667244A (zh) | 数据校验方法、装置、电子设备及计算机可读存储介质 | |
| CN115002100B (zh) | 文件传输方法、装置、电子设备及存储介质 | |
| CN115001805B (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 |