CN117610016A - 一种接口管理方法及装置 - Google Patents
一种接口管理方法及装置 Download PDFInfo
- Publication number
- CN117610016A CN117610016A CN202311631382.3A CN202311631382A CN117610016A CN 117610016 A CN117610016 A CN 117610016A CN 202311631382 A CN202311631382 A CN 202311631382A CN 117610016 A CN117610016 A CN 117610016A
- Authority
- CN
- China
- Prior art keywords
- parameter
- code
- interface
- interface document
- input
- 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 abstract description 113
- 238000012795 verification Methods 0.000 claims abstract description 62
- 238000000034 method Methods 0.000 claims abstract description 35
- 238000011161 development Methods 0.000 claims description 11
- 230000001960 triggered effect Effects 0.000 claims description 9
- 230000008569 process Effects 0.000 claims description 8
- 230000004044 response Effects 0.000 claims description 7
- 238000004458 analytical method Methods 0.000 claims description 5
- 238000004590 computer program Methods 0.000 description 14
- 238000012545 processing Methods 0.000 description 9
- 238000004891 communication Methods 0.000 description 8
- 238000001514 detection method Methods 0.000 description 6
- 238000010586 diagram Methods 0.000 description 5
- 230000006870 function Effects 0.000 description 5
- 230000009286 beneficial effect Effects 0.000 description 4
- 230000003287 optical effect Effects 0.000 description 3
- 230000008676 import Effects 0.000 description 2
- 230000003993 interaction Effects 0.000 description 2
- 238000012986 modification Methods 0.000 description 2
- 230000004048 modification Effects 0.000 description 2
- 230000008520 organization Effects 0.000 description 2
- 230000002787 reinforcement Effects 0.000 description 2
- 230000009471 action Effects 0.000 description 1
- 238000003491 array Methods 0.000 description 1
- 238000013473 artificial intelligence Methods 0.000 description 1
- 230000005540 biological transmission Effects 0.000 description 1
- 230000001413 cellular effect Effects 0.000 description 1
- 230000007547 defect Effects 0.000 description 1
- 238000013461 design Methods 0.000 description 1
- 230000000694 effects Effects 0.000 description 1
- 239000000284 extract Substances 0.000 description 1
- 238000000605 extraction Methods 0.000 description 1
- 239000011521 glass Substances 0.000 description 1
- 230000006872 improvement Effects 0.000 description 1
- 239000004973 liquid crystal related substance Substances 0.000 description 1
- 238000010801 machine learning Methods 0.000 description 1
- 239000013307 optical fiber Substances 0.000 description 1
- 238000012552 review Methods 0.000 description 1
- 239000004065 semiconductor Substances 0.000 description 1
- 230000001953 sensory effect Effects 0.000 description 1
- 238000006467 substitution reaction Methods 0.000 description 1
- 230000008719 thickening Effects 0.000 description 1
- 230000000007 visual effect Effects 0.000 description 1
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F21/00—Security arrangements for protecting computers, components thereof, programs or data against unauthorised activity
- G06F21/50—Monitoring users, programs or devices to maintain the integrity of platforms, e.g. of processors, firmware or operating systems
- G06F21/57—Certifying or maintaining trusted computer platforms, e.g. secure boots or power-downs, version controls, system software checks, secure updates or assessing vulnerabilities
- G06F21/577—Assessing vulnerabilities and evaluating computer system security
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/70—Software maintenance or management
- G06F8/71—Version control; Configuration management
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/70—Software maintenance or management
- G06F8/75—Structural analysis for program understanding
Landscapes
- Engineering & Computer Science (AREA)
- General Engineering & Computer Science (AREA)
- Software Systems (AREA)
- Theoretical Computer Science (AREA)
- Computer Security & Cryptography (AREA)
- Computer Hardware Design (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Computing Systems (AREA)
- Storage Device Security (AREA)
Abstract
本发明实施例公开了一种接口管理方法及装置。该方法可包括:针对已接入的目标代码库,对所述目标代码库中的源代码进行扫描,生成接口文档,其中,所述接口文档用于描述所述源代码中涉及的接口;对所述源代码进行扫描,得到所述源代码中记载的参数校验规则,其中,所述参数校验规则用于校验所述接口的输入参数;从所述接口文档中提取出所述输入参数的参数信息,并基于所述参数信息以及所述参数校验规则,对所述输入参数进行校验。本发明的技术方案,可以实现对输入参数的自动校验,由此提升了接口管理系统对于接口的管控能力。
Description
技术领域
本发明实施例涉及计算机技术领域,尤其涉及一种接口管理方法及装置。
背景技术
目前,网络安全越来越受到重视。为了实现安全编码,在代码编写过程中需要进行代码安全加固,特别是需要对所编写的与接口的输入参数对应的参数代码进行安全加固,这点至关重要。
需要说明的是,目前所编写的全部接口均需要登记到接口管理系统中,以基于接口管理系统进行各种接口的统一管理。
但是,目前应用的接口管理系统,无法自动校验接口的输入参数的正确性和/或安全性等,这会影响到接口管理系统对于接口的管控能力,有待改进。
发明内容
本发明实施例提供了一种接口管理方法及装置,以实现对输入参数的自动校验,由此提升了接口管理系统对于接口的管控能力。
根据本发明的一方面,提供了一种接口管理方法,包括:
针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口;
对源代码进行扫描,得到源代码中记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数;
从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验。
根据本发明的另一方面,提供了一种接口管理装置,包括:
接口文档生成模块,用于针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口;
参数校验规则得到模块,用于对源代码进行扫描,得到源代码中记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数;
输入参数校验模块,用于从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验。
本发明实施例的技术方案,通过接口管理系统,针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口,这里通过自动扫描源代码生成接口文档,提高了接口文档生成的效率和准确性;对源代码进行扫描,得到源代码中所记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数,参数校验规则的得到,可有助于实现对输入参数进行校验;从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验,提升了对输入参数的安全检测能力。上述技术方案,实现了接口文档的自动生成,并在此基础上进一步实现了接口文档中输入参数的自动校验,由此提升了接口管理系统对于接口的管控能力。
应当理解,本部分所描述的内容并非旨在标识本发明的实施例的关键或是重要特征,也不用于限制本发明的范围。本发明的其它特征将通过以下的说明书而变得容易理解。
附图说明
为了更清楚地说明本发明实施例中的技术方案,下面将对实施例描述中所需要使用的附图作简单地介绍,显而易见地,下面描述中的附图仅仅是本发明的一些实施例,对于本领域普通技术人员来讲,在不付出创造性劳动的前提下,还可以根据这些附图获得其他的附图。
图1是根据本发明实施例提供的一种接口管理方法的流程图;
图2是根据本发明实施例提供的另一种接口管理方法的流程图;
图3是根据本发明实施例提供的再一种接口管理方法的流程图;
图4是根据本发明实施例提供的又一种接口管理方法的流程图;
图5是根据本发明实施例提供的又一种接口管理方法中的具体示例的流程图;
图6是根据本发明实施例提供的又一种接口管理方法中的又一具体示例的流程图;
图7是根据本发明实施例提供的一种接口管理装置的结构框图;
图8是实现本发明实施例的接口管理方法的接口管理系统的结构示意图。
具体实施方式
为了使本技术领域的人员更好地理解本发明方案,下面将结合本发明实施例中的附图,对本发明实施例中的技术方案进行清楚、完整地描述,显然,所描述的实施例仅仅是本发明一部分的实施例,而不是全部的实施例。基于本发明中的实施例,本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例,都应当属于本发明保护的范围。
需要说明的是,本发明的说明书和权利要求书及上述附图中的术语“第一”、“第二”等是用于区别类似的对象,而不必用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换,以便这里描述的本发明的实施例能够以除了在这里图示或描述的那些以外的顺序实施。“目标”、“原始”等的情况类似,在此不再赘述。此外,术语“包括”和“具有”以及他们的任何变形,意图在于覆盖不排他的包含,例如,包含了一系列步骤或单元的过程、方法、系统、产品或设备不必限于清楚地列出的那些步骤或单元,而是可包括没有清楚地列出的或对于这些过程、方法、产品或设备固有的其它步骤或单元。
需要说明的是,本发明的技术方案中,所涉及到的用户个人信息的采集、收集、更新、分析、处理、使用、传输、存储等方面,均符合相关法律法规的规定,被用于合法的用途,且不违背公序良俗。对用户个人信息采取必要措施,从而防止对用户个人信息数据的非法访问,维护用户个人信息安全、网络安全和国家安全。
图1是本发明实施例所提供的一种接口管理方法的流程图。本实施例可适用于通过接口管理系统自动生成接口文档,并对该接口文档中的输入参数进行自动校验的情况。该方法可以由本发明实施例提供的接口管理装置来执行,该装置可以由软件和/或硬件的方式实现,该装置可以集成在接口管理系统上。
参见图1,本发明实施例的方法具体包括如下步骤:
S110、针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口。
其中,目标代码库可理解为已接入接口管理系统中的代码库,尤其可理解为针对其中存储的源代码,待生成用于描述该源代码中涉及的接口的接口文档的代码库。
源代码可理解为目标代码库中存储的代码,其中涉及到一个或多个接口。
接口文档可理解为对目标代码库中的源代码涉及的接口进行描述的文档。例如对接口的接口基本信息、接口调用信息、输入参数和输出参数等信息进行记录的文档。
由于目标代码库已接入接口管理系统,因此可通过接口管理系统,对目标代码库中所存储的源代码进行扫描,从而生成可用于描述该源代码中所涉及的接口的接口文档,由此实现了接口文档的自动生成。
可以理解的是,相较于开发人员到接口管理系统上手工登记接口这种方式,接口文档的自动生成,可有效提升接口登记的自动性和准确性。
S120、对源代码进行扫描,得到源代码中记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数。
其中,参数校验规则可理解为对输入参数进行校验的规范,例如参数类型校验规则、参数范围校验规则、参数越权校验规则以及参数长度校验规则等。通过参数校验规则对输入参数进行校验,可以有效提高业务系统运行的稳定性和安全性。
S130、从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验。
其中,参数信息可理解为输入参数的基本信息,例如输入参数的参数类型、参数范围和参数长度等信息。
通过对接入的目标代码库进行扫描,自动生成接口文档,并提取出接口文档中的输入参数的参数信息,再基于输入参数的参数信息以及从源代码中扫描得到的参数校验规则,完成对输入参数的自动校验。
本发明实施例的技术方案,通过接口管理系统,针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口,这里通过自动扫描源代码生成接口文档,提高了接口文档生成的效率和准确性;对源代码进行扫描,得到源代码中所记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数,参数校验规则的得到,可有助于实现对输入参数进行校验;从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验,提升了对输入参数的安全检测能力。上述技术方案,实现了接口文档的自动生成,并在此基础上进一步实现了接口文档中输入参数的自动校验,由此提升了接口管理系统对于接口的管控能力。
一种可选的技术方案,接口管理方法还包括:响应于代码库接入指令,确定代码库接入指令的触发对象;获取触发对象针对至少一个开发代码库分别对应的访问权限,并根据访问权限,从至少一个开发代码库中确定目标代码库;接入目标代码库。
其中,触发对象可理解为输入代码库接入指令的对象。
访问权限可理解为对开发代码库进行操作的权限,在实际应用中,可选的,可以是触发对象自身所拥有的权限,也可以是触发对象所在部门所拥有的权限,还可以是触发对象所在的组织架构所拥有的权限,可根据实际情况进行选择。
当接口管理系统接收到代码库接入指令后,确定触发该代码库接入指令的触发对象对于各个开发代码库分别对应的访问权限,并根据访问权限,从这些开发代码库中确定出可被触发对象访问的目标代码库并进行接入,由此实现了目标代码库的自动确定并接入,提高了代码库接入效率。
在实际应用中,可选的,接口管理系统在确定出目标代码库之后,可直接接入目标代码库,实现了目标代码库的全自动接入;也可结合触发对象输入的某些信息接入目标代码库,实现了目标代码库的半自动接入;等等,在此未做具体限定。
在此基础上,可选的,上述接口管理方法,还包括:获取触发对象输入的用于描述源代码的源代码信息;
接入目标代码库,包括:根据源代码信息,接入目标代码库。
其中,源代码信息可理解为源代码的基本信息,例如源代码名称、源代码语言(如Java、C#、C等)、源代码来源(如Git、TFS等)、源代码地址、源代码链接用户信息以及工程类型(如普通工程、maven工程等)等中的至少一个。
通过获取触发对象输入的源代码信息,可协助接口管理系统有效接入目标代码库,由此保证了目标代码库的接入成功率。
另一种可选的技术方案,对目标代码库中的源代码进行扫描,生成接口文档,包括:对目标代码库中的源代码进行扫描,以从源代码中提取出与输入参数关联的参数注释,其中,参数注释属于参数信息;至少基于参数注释,生成接口文档。
其中,参数注释可理解为对输入参数的注释,用于方便用户理解输入参数的功能和意义。
通过基于参数注释,生成接口文档,可以使用户可以通过参数注释了解接口和输入参数的具体功能,理解输入参数的作用,提高接口文档的可读性。
图2是本发明实施例中提供的另一种接口管理方法的流程图。本实施例以上述各技术方案为基础进行优化。在本实施例中,可选的,上述接口管理方法还包括:根据接口文档,从源代码中确定与输入参数对应的参数代码;调用代码安全扫描工具,以利用代码安全扫描工具,对参数代码进行扫描,验证参数代码的安全性。其中,与上述各实施例相同或相应的术语的解释在此不再赘述。
参见图2,本实施例的方法具体可以包括如下步骤:
S210、针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口。
S220、对源代码进行扫描,得到源代码中记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数。
S230、从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验。
S240、根据接口文档,从源代码中确定与输入参数对应的参数代码。
其中,参数代码可理解为源代码中输入参数所对应的代码。
S250、调用代码安全扫描工具,以利用代码安全扫描工具,对参数代码进行扫描,验证参数代码的安全性。
其中,代码安全扫描工具可理解为对代码进行安全检查和扫描,来检测代码中可能存在的潜在安全漏洞和缺陷的工具。
本发明实施例的技术方案,通过在接口管理系统中加入代码安全扫描工具,由此可通过调用代码安全扫描工具,对源代码中与输入参数对应的参数代码进行安全检测,进一步提高了对输入参数的安全检测能力。
在此基础上,一种可选的技术方案,上述接口管理方法,还包括:响应于安全规则配置指令,获取安全规则;调用代码安全扫描工具,以利用代码安全扫描工具,对参数代码进行扫描,验证参数代码的安全性,包括:基于安全规则,调用代码安全扫描工具,以使代码安全扫描工具,以安全规则为基准,扫描参数代码,以验证参数代码的安全性。
其中,安全规则配置指令可理解为用户触发的,用于对代码安全扫描工具中的安全规则进行配置的指令。
用户通过输入安全规则配置指令,进行个性化的安全规则配置。这样一来,在调用代码安全扫描工具时,以安全规则为基准,扫描参数代码,相比于自动生成的安全规则,可以根据参数代码的具体情况配置不同的安全规则,进一步提高参数代码的安全性。
图3是本发明实施例中提供的再一种接口管理方法的流程图。本实施例以上述各技术方案为基础进行优化。在本实施例中,可选的,输入参数的数量是至少一个,上述的接口管理方法还包括:展示接口文档;响应于针对展示出的接口文档中的至少一个输入参数触发的重要参数选中指令,确定至少一个输入参数中的重要参数;基于预设标记方式,对接口文档中的重要参数进行标记。其中,与上述各实施例相同或相应的术语的解释在此不再赘述。
参见图3,本实施例的方法具体可以包括如下步骤:
S310、针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口。
S320、对源代码进行扫描,得到源代码中记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数。
S330、从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验,输入参数的数量是至少一个。
S340、展示接口文档,并响应于针对展示出的接口文档中的至少一个输入参数触发的重要参数选中指令,确定至少一个输入参数中的重要参数。
其中,重要参数可理解为在各个输入参数中具有重要作用的参数。
可以首先对接口文档进行展示,例如可以通过网页对接口文档进行展示。在对接口文档进行展示后,用户可通过重要参数选中指令对重要参数进行选中,例如可以通过鼠标对重要参数进行选中等。
S350、基于预设标记方式,对接口文档中的重要参数进行标记。
其中,预设标记方式可理解为预设对重要参数进行标记的方式,例如可以是对重要参数进行加粗、高亮、标红或是标星等。
本发明实施例的技术方案,通过向用户展示接口文档,可方便用户对重要参数进行标记,进而可以通过标记的重要参数快速对输入参数进行检测,提高检测效率。
在此基础上,一种可选的技术方案,接口管理系统通过网页形式展示,展示接口文档,包括:通过读取并导入接口文档,以基于网页形式展示接口文档。
其中,通过网页形式对接口管理系统进行展示,可以方便用户对输入参数的参看和操作,进一步提高了接口管理系统对于接口的管控能力。
图4是本发明实施例中提供的又一种接口管理方法的流程图。本实施例以上述各技术方案为基础进行优化。在本实施例中,可选的,输入参数的数量是至少一个,上述的接口管理方法还包括:展示接口文档;响应于针对展示出的接口文档中的至少一个输入参数触发的流向参数选中指令,确定至少一个输入参数中的流向参数;获取流向参数的调用数据流向图,其中,调用数据流向图用于表征流向参数在源代码中的调用数据流向,调用数据流向在源代码的扫描过程中分析得到;对调用数据流向图进行展示。其中,与上述各实施例相同或相应的术语的解释在此不再赘述。
参见图4,本实施例的方法具体可以包括如下步骤:
S410、针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口。
S420、对源代码进行扫描,得到源代码中记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数。
S430、从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验,输入参数的数量是至少一个。
S440、展示接口文档,并响应于针对展示出的接口文档中的至少一个输入参数触发的流向参数选中指令,确定至少一个输入参数中的流向参数。
其中,流向参数可理解为各输入参数中待确定自身的调用数据流向的参数。
用户可以通过流向参数选中指令,从各输入参数中选中流向参数。
S450、获取流向参数的调用数据流向图,其中,调用数据流向图用于表征流向参数在源代码中的调用数据流向,调用数据流向在源代码的扫描过程中分析得到。
其中,调用数据流向图可理解为用于表征流向参数的调用数据流向的图,该调用数据流向可通过在源代码的扫描过程中进行分析得到。
S460、对调用数据流向图进行展示。
本发明实施例的技术方案,通过选中输入参数中流向参数,获取流向参数的调用数据流向图,对输入参数的调用路径进行追踪,实现了对接口输入参数的安全溯源管理,进一步提高接口管理系统对于接口的管控能力。
在此基础上,一种可选的技术方案,接口管理系统通过网页形式展示,展示接口文档,包括:通过读取并导入接口文档,以基于网页形式展示接口文档。
其中,通过网页形式对接口管理系统进行展示,可以方便用户对输入参数的参看和操作,进一步提高了接口管理系统对于接口的管控能力。
为了更好地理解上述的各个技术方案,下面结合具体示例进行示例性说明。具体流程如图5所示,示例性的,具体步骤如下:
步骤一:接口管理系统根据登录至自身的用户所在组织架构进行代码库访问权限划分,从各开发代码库中确定用户可访问的目标代码库,并接入该目标代码库。如下表所示,输入包含以下内容进行目标代码库导入。
输入项目 | 输入类型 |
源代码名称 | 自定义项目名称 |
检测语言 | Java、C#、C等 |
源代码来源 | Git、TFS等 |
源代码地址 | 代码库地址 |
源代码链接用户信息 | 代码库登录个人信息 |
工程类型 | 普通工程、maven工程 |
步骤二:接口管理系统扫描目标代码库中的源代码,自动生成接口文档,并将该接口文档导入至接口管理系统以进行展示,接口文档中可记录有如下表所示的内容:
接口管理系统读取目标代码库中的源代码,得到规则集,该规则集中包括多个参数校验规则;同时,用户可通过接口管理系统对输入参数进行人工重要参数信息(即重要参数)标记。如下表所示:
步骤三:在接口管理系统中配置代码安全扫描工具,同时支持个性化配置安全规则。用户可点击具体重点参数,展示参数调用流程图如图6所示,展示参数数据流向、代码层级数据处理规则以及代码安全配置具体规则,仅供内部人员查看,用于代码安全评审。而且对外提供接口输出时仅展示接口基本信息,不展示参数处理逻辑。
以上具体示例,通过自动生成接口文档,提高接口登记自动化水平,无需开发人员手工填写接口信息登记表,根据代码库直接扫描,提高开发效率;解决了手工填写易出错,实际代码和接口文档名称不匹配问题,实现文档与代码参数的一一对应;展示登记接口输入参数数据流向,能够直观展现客户输入项的数据处理流向,便于人工代码审查;结合代码库进行对应接口的代码安全扫描,增强了接口管理的安全管控。
图7为本发明实施例中提供的接口管理装置的结构框图,该装置用于执行上述任意实施例所提供的接口管理方法。该装置与上述各实施例的接口管理方法属于同一个发明构思,在接口管理装置的实施例中未详尽描述的细节内容,可参考上述接口管理方法的实施例。参见图7,该装置具体可以包括:接口文档生成模块510、参数校验规则得到模块520以及输入参数校验模块530。
其中,接口文档生成模块510,用于针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口;
参数校验规则得到模块520,用于对源代码进行扫描,得到源代码中记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数;
输入参数校验模块530,用于从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验。
可选的,接口管理装置还包括:
参数代码确定模块,用于根据接口文档,从源代码中确定与输入参数对应的参数代码;
参数代码验证模块,用于调用代码安全扫描工具,以利用代码安全扫描工具,对参数代码进行扫描,验证参数代码的安全性。
可选的,接口管理装置还包括:
安全规则获取模块,用于响应于安全规则配置指令,获取安全规则;
参数代码验证模块包括:
参数代码验证子模块,用于基于安全规则,调用代码安全扫描工具,以使代码安全扫描工具,以安全规则为基准,扫描参数代码,以验证参数代码的安全性。
可选的,输入参数的数量是至少一个,接口管理装置还包括:
接口文档展示模块,用于展示接口文档;
重要参数确定模块,用于响应于针对展示出的接口文档中的至少一个输入参数触发的重要参数选中指令,确定至少一个输入参数中的重要参数;
重要参数标记模块,用于基于预设标记方式,对接口文档中的重要参数进行标记。
可选的,输入参数的数量是至少一个,接口管理装置还包括:
接口文档展示模块,用于展示接口文档;
流向参数确定模块,响应于针对展示出的接口文档中的至少一个输入参数触发的流向参数选中指令,确定至少一个输入参数中的流向参数;
调用数据流向图获取模块,用于获取流向参数的调用数据流向图,其中,调用数据流向图用于表征流向参数在源代码中的调用数据流向,调用数据流向在源代码的扫描过程中分析得到;
调用数据流向图展示模块,用于对调用数据流向图进行展示。
可选的,接口管理系统通过网页形式展示,接口文档展示模块包括:
接口文档展示子模块,用于通过读取并导入接口文档,以基于网页形式展示接口文档。
可选的,接口管理装置还包括:
触发对象确定模块,用于响应于代码库接入指令,确定代码库接入指令的触发对象;
目标代码库确定模块,用于获取触发对象针对至少一个开发代码库分别对应的访问权限,并根据访问权限,从至少一个开发代码库中确定目标代码库;
目标代码库接入模块,用于接入目标代码库。
在此基础上,可选的,接口管理装置还包括:
源代码信息获取模块,用于获取触发对象输入的用于描述源代码的源代码信息;
可选的,目标代码库接入模块,包括
目标代码库接入子模块,用于根据源代码信息,接入目标代码库。
可选的,接口文档生成模块包括:
参数注释提取子模块,用于对目标代码库中的源代码进行扫描,以从源代码中提取出与输入参数关联的参数注释,其中,参数注释属于参数信息;
接口文档生成子模块,用于至少基于参数注释,生成接口文档。
本发明实施例所提供的接口管理装置,通过接口文档生成模块,针对已接入的目标代码库,对目标代码库中的源代码进行扫描,生成接口文档,其中,接口文档用于描述源代码中涉及的接口,这里通过自动扫描源代码生成接口文档,提高了接口文档生成的效率和准确性;通过参数校验规则得到模块,对源代码进行扫描,得到源代码中所记载的参数校验规则,其中,参数校验规则用于校验接口的输入参数,参数校验规则的得到,可有助于实现对输入参数进行校验;通过输入参数校验模块,从接口文档中提取出输入参数的参数信息,并基于参数信息以及参数校验规则,对输入参数进行校验,提升了对输入参数的安全检测能力。上述接口管理装置,实现了接口文档的自动生成,并在此基础上进一步实现了接口文档中输入参数的自动校验,由此提升了接口管理系统对于接口的管控能力。
本发明实施例所提供的接口管理装置可以执行本发明任意实施例所提供的接口管理方法,具备执行方法相应的功能模块和有益效果。
值得注意的是,上述接口管理装置的实施例中,所包括的各个单元和模块只是按照功能逻辑进行划分的,但并不局限于上述的划分,只要能够实现相应的功能即可;另外,各功能单元的具体名称也只是为了便于相互区分,并不用于限制本发明的保护范围。
图8示出了可以用来实施本发明的实施例的接口管理系统10的结构示意图。接口管理系统旨在表示各种形式的数字计算机,诸如,膝上型计算机、台式计算机、工作台、个人数字助理、服务器、刀片式服务器、大型计算机、和其它适合的计算机。接口管理系统还可以表示各种形式的移动装置,诸如,个人数字处理、蜂窝电话、智能电话、可穿戴设备(如头盔、眼镜、手表等)和其它类似的计算装置。本文所示的部件、它们的连接和关系、以及它们的功能仅仅作为示例,并且不意在限制本文中描述的和/或者要求的本发明的实现。
如图8所示,接口管理系统10包括至少一个处理器11,以及与至少一个处理器11通信连接的存储器,如只读存储器(ROM)12、随机访问存储器(RAM)13等,其中,存储器存储有可被至少一个处理器执行的计算机程序,处理器11可以根据存储在只读存储器(ROM)12中的计算机程序或从存储单元18加载到随机访问存储器(RAM)13中的计算机程序,来执行各种适当的动作和处理。在RAM13中,还可存储接口管理系统10操作所需的各种程序和数据。处理器11、ROM12以及RAM13通过总线14彼此相连。输入/输出(I/O)接口15也连接至总线14。
接口管理系统10中的多个部件连接至I/O接口15,包括:输入单元16,例如键盘、鼠标等;输出单元17,例如各种类型的显示器、扬声器等;存储单元18,如磁盘、光盘等;以及通信单元19,例如网卡、调制解调器、无线通信收发机等。通信单元19允许接口管理系统10通过诸如因特网的计算机网络和/或各种电信网络与其他设备交换信息/数据。
处理器11可以是各种具有处理和计算能力的通用和/或专用处理组件。处理器11的一些示例包括但不限于中央处理单元(CPU)、图形处理单元(GPU)、各种专用的人工智能(AI)计算芯片、各种运行机器学习模型算法的处理器、数字信号处理器(DSP)、以及任何适当的处理器、控制器、微控制器等。处理器11执行上文所描述的各个方法和处理,例如接口管理方法。
在一些实施例中,接口管理方法可被实现为计算机程序,其被有形地包含于计算机可读存储介质,例如存储单元18。在一些实施例中,计算机程序的部分或者全部可以经由ROM12和/或通信单元19而被载入和/或安装到接口管理系统10上。当计算机程序加载到RAM13并由处理器11执行时,可以执行上文描述的接口管理方法的一个或多个步骤。备选地,在其他实施例中,处理器11可通过其他任何适当的方式(例如,借助于固件)而被配置为执行接口管理方法。
本文中以上描述的系统和技术的各种实施方式可以在数字电子电路系统、集成电路系统、场可编程门阵列(FPGA)、专用集成电路(ASIC)、专用标准产品(ASSP)、芯片上系统的系统(SOC)、负载可编程逻辑设备(CPLD)、计算机硬件、固件、软件、和/或它们的组合中实现。这些各种实施方式可以包括:实施在一个或者多个计算机程序中,该一个或者多个计算机程序可在包括至少一个可编程处理器的可编程系统上执行和/或解释,该可编程处理器可以是专用或者通用可编程处理器,可以从存储系统、至少一个输入装置、以及至少一个输出装置接收数据和指令,并且将数据和指令传输至该存储系统、该至少一个输入装置、以及该至少一个输出装置。
用于实施本发明的方法的计算机程序可以采用一个或多个编程语言的任何组合来编写。这些计算机程序可以提供给通用计算机、专用计算机或是其他可编程数据处理装置的处理器,使得计算机程序当由处理器执行时使流程图和/或框图中所规定的功能/操作被实施。计算机程序可以完全在机器上执行、部分地在机器上执行,作为独立软件包部分地在机器上执行并且部分地在远程机器上执行或完全在远程机器或服务器上执行。
在本发明的上下文中,计算机可读存储介质可以是有形的介质,其可以包含或存储以供指令执行系统、装置或设备使用或与指令执行系统、装置或设备结合地使用的计算机程序。计算机可读存储介质可以包括但不限于电子的、磁性的、光学的、电磁的、红外的、或半导体系统、装置或设备,或者上述内容的任何合适组合。备选地,计算机可读存储介质可以是机器可读信号介质。机器可读存储介质的更具体示例会包括基于一个或多个线的电气连接、便携式计算机盘、硬盘、随机存取存储器(RAM)、只读存储器(ROM)、可擦除可编程只读存储器(EPROM或快闪存储器)、光纤、便捷式紧凑盘只读存储器(CD-ROM)、光学储存设备、磁储存设备、或上述内容的任何合适组合。
为了提供与用户的交互,可以在接口管理系统上实施此处描述的系统和技术,该接口管理系统具有:用于向用户显示信息的显示装置(例如,CRT(阴极射线管)或者LCD(液晶显示器)监视器);以及键盘和指向装置(例如,鼠标或者轨迹球),用户可以通过该键盘和该指向装置来将输入提供给接口管理系统。其它种类的装置还可以用于提供与用户的交互;例如,提供给用户的反馈可以是任何形式的传感反馈(例如,视觉反馈、听觉反馈、或者触觉反馈);并且可以用任何形式(包括声输入、语音输入或者、触觉输入)来接收来自用户的输入。
可以将此处描述的系统和技术实施在包括后台部件的计算系统(例如,作为数据服务器)、或者包括中间件部件的计算系统(例如,应用服务器)、或者包括前端部件的计算系统(例如,具有图形用户界面或者网络浏览器的用户计算机,用户可以通过该图形用户界面或者该网络浏览器来与此处描述的系统和技术的实施方式交互)、或者包括这种后台部件、中间件部件、或者前端部件的任何组合的计算系统中。可以通过任何形式或者介质的数字数据通信(例如,通信网络)来将系统的部件相互连接。通信网络的示例包括:局域网(LAN)、广域网(WAN)、区块链网络和互联网。
计算系统可以包括客户端和服务器。客户端和服务器一般远离彼此并且通常通过通信网络进行交互。通过在相应的计算机上运行并且彼此具有客户端-服务器关系的计算机程序来产生客户端和服务器的关系。服务器可以是云服务器,又称为云计算服务器或云主机,是云计算服务体系中的一项主机产品,以解决了传统物理主机与VPS服务中,存在的管理难度大,业务扩展性弱的缺陷。
应该理解,可以使用上面所示的各种形式的流程,重新排序、增加或删除步骤。例如,本发明中记载的各步骤可以并行地执行也可以顺序地执行也可以不同的次序执行,只要能够实现本发明的技术方案所期望的结果,本文在此不进行限制。
上述具体实施方式,并不构成对本发明保护范围的限制。本领域技术人员应该明白的是,根据设计要求和其他因素,可以进行各种修改、组合、子组合和替代。任何在本发明的精神和原则之内所作的修改、等同替换和改进等,均应包含在本发明保护范围之内。
Claims (10)
1.一种接口管理方法,其特征在于,应用于接口管理系统,所述方法包括:
针对已接入的目标代码库,对所述目标代码库中的源代码进行扫描,生成接口文档,其中,所述接口文档用于描述所述源代码中涉及的接口;
对所述源代码进行扫描,得到所述源代码中记载的参数校验规则,其中,所述参数校验规则用于校验所述接口的输入参数;
从所述接口文档中提取出所述输入参数的参数信息,并基于所述参数信息以及所述参数校验规则,对所述输入参数进行校验。
2.根据权利要求1所述的方法,其特征在于,还包括:
根据所述接口文档,从所述源代码中确定与所述输入参数对应的参数代码;
调用代码安全扫描工具,以利用所述代码安全扫描工具,对所述参数代码进行扫描,验证所述参数代码的安全性。
3.根据权利要求2所述的方法,其特征在于,还包括:
响应于安全规则配置指令,获取安全规则;
所述调用代码安全扫描工具,以利用所述代码安全扫描工具,对所述参数代码进行扫描,验证所述参数代码的安全性,包括:
基于所述安全规则,调用代码安全扫描工具,以使所述代码安全扫描工具,以所述安全规则为基准,扫描所述参数代码,以验证所述参数代码的安全性。
4.根据权利要求1所述的方法,其特征在于,所述输入参数的数量是至少一个,所述方法还包括:
展示所述接口文档;
响应于针对展示出的所述接口文档中的所述至少一个输入参数触发的重要参数选中指令,确定所述至少一个输入参数中的重要参数;
基于预设标记方式,对所述接口文档中的所述重要参数进行标记。
5.根据权利要求1所述的方法,其特征在于,所述输入参数的数量是至少一个,所述方法还包括:
展示所述接口文档;
响应于针对展示出的所述接口文档中的所述至少一个输入参数触发的流向参数选中指令,确定所述至少一个输入参数中的流向参数;
获取所述流向参数的调用数据流向图,其中,所述调用数据流向图用于表征所述流向参数在所述源代码中的调用数据流向,所述调用数据流向在所述源代码的扫描过程中分析得到;
对所述调用数据流向图进行展示。
6.根据权利要求4或5所述的方法,其特征在于,所述接口管理系统通过网页形式展示,所述展示所述接口文档,包括:
通过读取并导入所述接口文档,以基于所述网页形式展示所述接口文档。
7.根据权利要求1所述的方法,其特征在于,还包括:
响应于代码库接入指令,确定所述代码库接入指令的触发对象;
获取所述触发对象针对至少一个开发代码库分别对应的访问权限,并根据所述访问权限,从所述至少一个开发代码库中确定所述目标代码库;
接入所述目标代码库。
8.根据权利要求7所述的方法,其特征在于,还包括:
获取所述触发对象输入的用于描述所述源代码的源代码信息;
所述接入所述目标代码库,包括:
根据所述源代码信息,接入所述目标代码库。
9.根据权利要求1所述的方法,其特征在于,所述对所述目标代码库中的源代码进行扫描,生成接口文档,包括:
对所述目标代码库中的源代码进行扫描,以从所述源代码中提取出与所述输入参数关联的参数注释,其中,所述参数注释属于所述参数信息;
至少基于所述参数注释,生成接口文档。
10.一种接口管理装置,其特征在于,配置于接口管理系统上,所述装置包括:
接口文档生成模块,用于针对已接入的目标代码库,对所述目标代码库中的源代码进行扫描,生成接口文档,其中,所述接口文档用于描述所述源代码中涉及的接口;
参数校验规则得到模块,用于对所述源代码进行扫描,得到所述源代码中记载的参数校验规则,其中,所述参数校验规则用于校验所述接口的输入参数;
输入参数校验模块,用于从所述接口文档中提取出所述输入参数的参数信息,并基于所述参数信息以及所述参数校验规则,对所述输入参数进行校验。
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202311631382.3A CN117610016A (zh) | 2023-11-30 | 2023-11-30 | 一种接口管理方法及装置 |
Applications Claiming Priority (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CN202311631382.3A CN117610016A (zh) | 2023-11-30 | 2023-11-30 | 一种接口管理方法及装置 |
Publications (1)
Publication Number | Publication Date |
---|---|
CN117610016A true CN117610016A (zh) | 2024-02-27 |
Family
ID=89959488
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
CN202311631382.3A Pending CN117610016A (zh) | 2023-11-30 | 2023-11-30 | 一种接口管理方法及装置 |
Country Status (1)
Country | Link |
---|---|
CN (1) | CN117610016A (zh) |
-
2023
- 2023-11-30 CN CN202311631382.3A patent/CN117610016A/zh active Pending
Similar Documents
Publication | Publication Date | Title |
---|---|---|
CN110474900B (zh) | 一种游戏协议测试方法及装置 | |
CN107145784B (zh) | 一种漏洞扫描的方法、装置及计算机可读介质 | |
US11886802B2 (en) | Adaptive autofill systems and methods | |
CN116089258A (zh) | 数据迁移测试方法、装置、设备、存储介质及程序产品 | |
CN111355709A (zh) | 数据验证方法、装置、电子设备及计算机可读存储介质 | |
CN116340172A (zh) | 基于测试场景的数据收集方法、装置及测试用例检测方法 | |
CN116009847A (zh) | 代码生成方法、装置、电子设备及存储介质 | |
CN110209572A (zh) | 用户界面测试方法、用户界面测试系统及终端 | |
CN117610016A (zh) | 一种接口管理方法及装置 | |
CN113886216B (zh) | 接口测试和工具配置方法、装置、电子设备和存储介质 | |
CN112000573B (zh) | 代码质量的监控方法、装置、计算机设备及介质 | |
CN114637672A (zh) | 自动化数据测试方法、装置、计算机设备及存储介质 | |
CN114443493A (zh) | 一种测试案例生成方法、装置、电子设备和存储介质 | |
CN111258628A (zh) | 一种规则文件比对方法、装置、可读存储介质及终端设备 | |
CN118133794B (zh) | 一种表格配置方法、装置、设备及存储介质 | |
CN116483377B (zh) | 一种代码检测方法、装置、电子设备及存储介质 | |
CN116483735B (zh) | 一种代码变更的影响分析方法、装置、存储介质及设备 | |
CN117150215B (zh) | 一种考核结果确定方法、装置、电子设备及存储介质 | |
CN111338941B (zh) | 信息处理方法和装置、电子设备和存储介质 | |
CN117609064A (zh) | 单元测试方法、装置、电子设备及存储介质 | |
CN117453747A (zh) | 一种数据质量检测方法、装置、电子设备及存储介质 | |
CN118673883A (zh) | 书籍段落评论的生成方法、装置、电子设备和存储介质 | |
CN118673437A (zh) | 基于知识图谱的审核规则异常查验方法、装置及电子设备 | |
CN117592025A (zh) | 一种数据展示方法、装置、电子设备及存储介质 | |
CN114760086A (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 |