CN112306549A - 接口文档配置方法、装置、设备及存储介质 - Google Patents

Abstract

本发明涉及计算机技术领域，公开了一种接口文档配置方法、装置、设备及存储介质，用于提高提高接口文档生成效率和接口文档兼容性。接口文档配置方法包括：获取目标源代码信息和目标配置模板；通过预设源代码缺陷分析工具对目标源代码信息进行分析，得到分析结果；当分析结果为未通过时，向终端发送预警信息；当分析结果为通过时，调用预设源代码解析器解析目标源代码信息，得到接口参数数据；获取初始参数值，对初始参数值进行数据脱敏处理和数据封装，得到响应数据；基于目标配置模板对接口参数数据和响应数据进行数据组合和文档导出，得到接口配置文件。此外，本发明还涉及区块链技术，接口参数数据可存储于区块链节点中。

Description

接口文档配置方法、装置、设备及存储介质

技术领域

本发明涉及计算机技术领域，尤其涉及一种接口文档配置方法、装置、设备及存储介质。

背景技术

在软件项目开发过程中，一般采用前后端分离的开发模式，通常后端提供多个访问接口，前端通过各访问接口进行数据增删改查，前后端需要按照接口文档进行接口开发与调试，从而提高开发效率。

在现有技术中，通过采用注解侵入生成接口文档，对不同注解方式设置不同的解析方法，接口文档包括接口的各种属性、参数说明，但是生成的接口文档格式有限，对测试工具postman测试接口不兼容，存在接口文档生成效率低和接口文档兼容性差的问题。

发明内容

本发明提供了一种接口文档配置方法、装置、设备及存储介质，用于提高接口文档生成效率和接口文档兼容性。

为实现上述目的，本发明第一方面提供了一种接口文档配置方法，包括：当接收到接口文档配置请求时，按照所述接口文档配置请求获取目标源代码信息和目标配置模板；通过预设源代码缺陷分析工具对所述目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对所述代码分析树进行静态代码分析，得到分析结果；当所述分析结果为未通过时，从所述目标源代码信息中获取异常代码信息和异常代码类型，按照所述异常代码类型对所述异常代码信息设置预警信息，并向终端发送所述预警信息，以使得所述终端提示目标用户按照所述预警信息对所述异常代码信息进行纠错处理；当所述分析结果为通过时，调用预设源代码解析器解析所述目标源代码信息，得到接口参数数据，所述接口参数数据包括参数名称和数据类型；按照所述数据类型对所述参数名称分配对应的初始参数值，对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对所述参数名称和所述脱敏后的参数值进行数据封装，得到响应数据；基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件。

可选的，在本发明第一方面的第一种实现方式中，所述当接收到接口文档配置请求时，按照所述接口文档配置请求获取目标源代码信息和目标配置模板，包括：当接收到接口文档配置请求时，对所述接口文档配置请求进行解析，得到目标文档标识信息和待配置文档类型；按照所述目标文档标识信息从预设数据库中查询目标文档路径信息，并根据所述目标文档路径信息读取目标源代码信息；按照所述待配置文档类型从所述预设数据库中匹配目标配置模板。

可选的，在本发明第一方面的第二种实现方式中，所述当所述分析结果为通过时，调用预设源代码解析器解析所述目标源代码信息，得到接口参数数据，所述接口参数数据包括参数名称和数据类型，包括：当所述分析结果为通过时，调用预设源代码解析器将所述目标源代码信息转换为目标源码树，所述目标源码树包括结点类型为源码的多个结点；对所述目标源码树中的每个结点按照预设参数维度进行解析并组合，得到接口参数数据，所述接口参数数据包括参数名称和数据类型。

可选的，在本发明第一方面的第三种实现方式中，所述按照所述数据类型对所述参数名称分配对应的初始参数值，对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对所述参数名称和所述脱敏后的参数值进行数据封装，得到响应数据，包括：按照所述数据类型和所述参数名称查询预设配置表，得到参数生成规则；按照所述参数生成规则对所述参数名称动态分配初始参数值，所述参数名称与所述初始参数值具有对应关系；从所述预设配置表中读取参数脱敏规则，并根据所述参数脱敏规则对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值；按照预设数据格式将所述参数名称与所述脱敏后的参数值进行数据封装，得到响应数据，并对所述响应数据进行存储。

可选的，在本发明第一方面的第四种实现方式中，所述基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件，包括：通过预设正则匹配规则从所述目标配置模板中提取待替换标签，并对所述待替换标签进行解析，得到解析结果，所述解析结果用于指示待替换数据类型；获取所述目标源代码信息对应的接口访问地址，并按照所述解析结果将所述接口访问地址、所述接口参数数据和所述响应数据填充至所述目标配置模板中，得到目标文本流；按照预设命名规则将所述目标文本流写入至预设文件目录中，得到接口配置文件。

可选的，在本发明第一方面的第五种实现方式中，所述基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件之后，所述接口文档配置方法还包括：当接收到接口配置文件更新请求时，从所述接口配置文件更新请求中读取待更新参数信息、待更新接口版本号和待变更接口唯一标识；按照所述待变更接口唯一标识获取已存储接口版本号，当所述已存储接口版本号与所述待更新接口版本号不一致时，根据所述待更新接口信息生成文档变更记录，并将所述已存储接口版本号变更为所述待更新接口版本号。

可选的，在本发明第一方面的第六种实现方式中，在所述基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件之后，所述接口文档配置方法还包括：当接收到患者就诊记录信息查询请求时，按照所述患者就诊记录信息查询请求查询目标接口配置文件；基于所述目标接口配置文件生成患者就诊记录信息，并将所述患者就诊记录信息发送至所述终端。

本发明第二方面提供了一种接口文档配置装置，包括：获取模块，当接收到接口文档配置请求时，用于按照所述接口文档配置请求获取目标源代码信息和目标配置模板；分析模块，用于通过预设源代码缺陷分析工具对所述目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对所述代码分析树进行静态代码分析，得到分析结果；预警模块，当所述分析结果为未通过时，用于从所述目标源代码信息中获取异常代码信息和异常代码类型，按照所述异常代码类型对所述异常代码信息设置预警信息，并向终端发送所述预警信息，以使得所述终端提示目标用户按照所述预警信息对所述异常代码信息进行纠错处理；解析模块，当所述分析结果为通过时，用于调用预设源代码解析器解析所述目标源代码信息，得到接口参数数据，所述接口参数数据包括参数名称和数据类型；脱敏模块，用于按照所述数据类型对所述参数名称分配对应的初始参数值，对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对所述参数名称和所述脱敏后的参数值进行数据封装，得到响应数据；导出模块，用于基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件。

可选的，在本发明第二方面的第一种实现方式中，所述获取模块具体用于：当接收到接口文档配置请求时，对所述接口文档配置请求进行解析，得到目标文档标识信息和待配置文档类型；按照所述目标文档标识信息从预设数据库中查询目标文档路径信息，并根据所述目标文档路径信息读取目标源代码信息；按照所述待配置文档类型从所述预设数据库中匹配目标配置模板。

可选的，在本发明第二方面的第二种实现方式中，所述解析模块具体用于：当所述分析结果为通过时，调用预设源代码解析器将所述目标源代码信息转换为目标源码树，所述目标源码树包括结点类型为源码的多个结点；对所述目标源码树中的每个结点按照预设参数维度进行解析并组合，得到接口参数数据，所述接口参数数据包括参数名称和数据类型。

可选的，在本发明第二方面的第三种实现方式中，所述脱敏模块具体用于：按照所述数据类型和所述参数名称查询预设配置表，得到参数生成规则；按照所述参数生成规则对所述参数名称动态分配初始参数值，所述参数名称与所述初始参数值具有对应关系；从所述预设配置表中读取参数脱敏规则，并根据所述参数脱敏规则对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值；按照预设数据格式将所述参数名称与所述脱敏后的参数值进行数据封装，得到响应数据，并对所述响应数据进行存储。

可选的，在本发明第二方面的第四种实现方式中，所述导出模块具体用于：通过预设正则匹配规则从所述目标配置模板中提取待替换标签，并对所述待替换标签进行解析，得到解析结果，所述解析结果用于指示待替换数据类型；获取所述目标源代码信息对应的接口访问地址，并按照所述解析结果将所述接口访问地址、所述接口参数数据和所述响应数据填充至所述目标配置模板中，得到目标文本流；按照预设命名规则将所述目标文本流写入至预设文件目录中，得到接口配置文件。

可选的，在本发明第二方面的第五种实现方式中，所述接口文档配置装置还包括：读取模块，当接收到接口配置文件更新请求时，从所述接口配置文件更新请求中读取待更新参数信息、待更新接口版本号和待变更接口唯一标识；变更模块，用于按照所述待变更接口唯一标识获取已存储接口版本号，当所述已存储接口版本号与所述待更新接口版本号不一致时，根据所述待更新接口信息生成文档变更记录，并将所述已存储接口版本号变更为所述待更新接口版本号。

可选的，在本发明第二方面的第六种实现方式中，所述接口文档配置装置还包括：查询模块，当接收到患者就诊记录信息查询请求时，按照所述患者就诊记录信息查询请求查询目标接口配置文件；生成模块，用于基于所述目标接口配置文件生成患者就诊记录信息，并将所述患者就诊记录信息发送至所述终端。

本发明第三方面提供了一种接口文档配置设备，包括：存储器和至少一个处理器，所述存储器中存储有指令；所述至少一个处理器调用所述存储器中的所述指令，以使得所述接口文档配置设备执行上述的接口文档配置方法。

本发明的第四方面提供了一种计算机可读存储介质，所述计算机可读存储介质中存储有指令，当其在计算机上运行时，使得计算机执行上述的接口文档配置方法。

本发明提供的技术方案中，当接收到接口文档配置请求时，按照所述接口文档配置请求获取目标源代码信息和目标配置模板；通过预设源代码缺陷分析工具对所述目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对所述代码分析树进行静态代码分析，得到分析结果；当所述分析结果为未通过时，从所述目标源代码信息中获取异常代码信息和异常代码类型，按照所述异常代码类型对所述异常代码信息设置预警信息，并向终端发送所述预警信息，以使得所述终端提示目标用户按照所述预警信息对所述异常代码信息进行纠错处理；当所述分析结果为通过时，调用预设源代码解析器解析所述目标源代码信息，得到接口参数数据，所述接口参数数据包括参数名称和数据类型；按照所述数据类型对所述参数名称分配对应的初始参数值，对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对所述参数名称和所述脱敏后的参数值进行数据封装，得到响应数据；基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件。本发明实施例中，通过预设源代码缺陷分析工具对目标源代码信息进行静态代码分析，当分析未通过时，向终端发送预警信息，以使得终端按照预警信息对异常代码信息进行纠错处理，提高了异常代码预警效率和纠错处理效率；当分析通过时，按照java标准注释进行参数解析、分类和脱敏处理后，生成一个兼容不同文件类型的接口配置文档，提高了接口文档的生成效率和接口文档的兼容性。

附图说明

图1为本发明实施例中接口文档配置方法的一个实施例示意图；

图2为本发明实施例中接口文档配置方法的另一个实施例示意图；

图3为本发明实施例中接口文档配置装置的一个实施例示意图；

图4为本发明实施例中接口文档配置装置的另一个实施例示意图；

图5为本发明实施例中接口文档配置设备的一个实施例示意图。

具体实施方式

本发明实施例提供了一种接口文档配置方法、装置、设备及存储介质，用于，通过预设源代码缺陷分析工具对目标源代码信息进行静态代码分析，按照java标准注释进行参数解析、分类和脱敏处理后，生成一个兼容不同文件类型的接口配置文档，提高接口文档的生成效率和接口文档的兼容性。

本发明的说明书和权利要求书及上述附图中的术语“第一”、“第二”、“第三”、“第四”等(如果存在)是用于区别类似的对象，而不必用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便这里描述的实施例能够以除了在这里图示或描述的内容以外的顺序实施。此外，术语“包括”或“具有”及其任何变形，意图在于覆盖不排他的包含，例如，包含了一系列步骤或单元的过程、方法、系统、产品或设备不必限于清楚地列出的那些步骤或单元，而是可包括没有清楚地列出的或对于这些过程、方法、产品或设备固有的其它步骤或单元。

为便于理解，下面对本发明实施例的具体流程进行描述，请参阅图1，本发明实施例中接口文档配置方法的一个实施例包括：

101、当接收到接口文档配置请求时，按照接口文档配置请求获取目标源代码信息和目标配置模板。

其中，接口文档配置请求包括目标文档标识信息和待配置文档类型。例如，待配置文档类型可以为JS对象简谱(JavaScript Object Notation，JSON)类型，也可以为标记语言asciidoc类型，具体此处不做限定。进一步地，服务器解析接口文档配置请求，得到目标文档标识信息和待配置文档类型，服务器按照目标文档标识信息和待配置文档类型获取目标源代码信息和目标配置模板。

可以理解的是，本发明的执行主体可以为接口文档配置装置，还可以是终端或者服务器，具体此处不做限定。本发明实施例以服务器为执行主体为例进行说明。

102、通过预设源代码缺陷分析工具对目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对代码分析树进行静态代码分析，得到分析结果。

具体的，服务器通过预设源代码缺陷分析工具对目标源代码信息进行合法性检查，以确保其符合代码逻辑设计，并排除代码缺陷。其中，预设代码缺陷自动分析工具可以为Java代码缺陷自动分析工具PMD或checkstyle，也可以为其他代码分析工具，具体此处不做限定。进一步地，服务器通过预设源代码缺陷分析工具对目标源代码信息分析并构建代码分析树；服务器采用PMD或checkstyle对代码分析树进行静态代码分析，得到分析结果。例如，服务器通过预设源代码缺陷分析工具确定目标源代码信息中存在空的语句块(例如，switch语句块)、冗余的if语句或者重复代码块时，服务器确定分析结果为未通过，服务器执行步骤103；否则，服务器确定分析结果为通过，服务器执行步骤104。

103、当分析结果为未通过时，从目标源代码信息中获取异常代码信息和异常代码类型，按照异常代码类型对异常代码信息设置预警信息，并向终端发送预警信息，以使得终端提示目标用户按照预警信息对异常代码信息进行纠错处理。

其中，异常代码类型包括错误类型、警告类型及提示类型。具体的，当分析结果为未通过时，服务器从目标源代码信息中获取异常代码信息和异常代码类型，并将异常代码信息和异常代码类型存储至预设日志表中，服务器按照异常代码类型获取预警模板，并基于预警模板组合异常代码信息，得到预警信息，并向终端发送预警信息，以使得终端提示目标用户按照预警信息对异常代码信息进行纠错处理。进一步地，服务器还可以定时对预设日志表进行分析，得到异常代码分析表，并将异常代码分析表发送至终端，以使得终端展示异常代码分析表。

可以理解的是，服务器在执行代码缺陷分析过程中对不符合预设源代码语法检测规则的代码信息(异常代码信息)进行预警，提高了目标源代码信息的正确性。

104、当分析结果为通过时，调用预设源代码解析器解析目标源代码信息，得到接口参数数据，接口参数数据包括参数名称和数据类型。

其中，接口参数数据可以包括一个参数、两个参数或者多个参数，具体此处不做限定。其中，预设源代码解析器可以为java源代码解析器，也可以为其他源代码解析器，具体此处不做限定。具体的，服务器调用预设源代码解析器解析并识别目标源代码信息的语法结构，得到结点类型为源码的结点树；服务器获取结点树(目标源码树)中的每个结点包含的接口标识信息；服务器按照接口标识信息确定每个结点中的接口类；服务器解析接口类，对接口类中的每个函数进行分析，得到函数集；服务器从函数集中提取参数名称和参数类型，得到接口参数数据。

105、按照数据类型对参数名称分配对应的初始参数值，对初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对参数名称和脱敏后的参数值进行数据封装，得到响应数据。

具体的，服务器可以通过随机生成库faker库、通用唯一识别码UUID或者随机数据按照数据类型对参数名称分配对应的初始参数值，也可以从预设配置表中读取参数名称对应的初始参数值，其中，预设配置表包括服务器从多个预设业务的数据源中全量抽取的数据，例如，服务器对参数名称为user_name、id_card和create_time分别分配对应的初始参数值，其中，身份证号id_card属于敏感参数，服务器还需要对其进行脱敏处理，得到脱敏后的参数值，以使得提高数据安全性，然后服务器封装参数名称和脱敏后的参数值，得到响应数据为{"user_name":"小明.李","id_card":"123456789654987321","create_time":"2020-08-07 14:20:19"}。

106、基于目标配置模板对接口参数数据和响应数据进行数据组合，得到目标文本流，并对目标文本流进行文档导出，得到接口配置文件。

其中，目标配置模板用于指示预先设置的包含有排版样式的至少一个待填充内容的文件模板，至少一个待填充内容可以采用预先设置的占位符进行表示。具体的，服务器在目标配置模板中，按照接口参数数据和响应数据替换占位符，得到目标文本流，并对目标文本流按照预设文件名称进行文档导出，得到接口配置文件。进一步地，将接口参数数据存储于区块链数据库中，具体此处不做限定。

本发明实施例中，通过预设源代码缺陷分析工具对目标源代码信息进行静态代码分析，当分析未通过时，向终端发送预警信息，以使得终端按照预警信息对异常代码信息进行纠错处理，提高了异常代码预警效率和纠错处理效率；当分析通过时，按照java标准注释进行参数解析、分类和脱敏处理后，生成一个兼容不同文件类型的接口配置文档，提高了接口文档的生成效率和接口文档的兼容性。

请参阅图2，本发明实施例中接口文档配置方法的另一个实施例包括：

201、当接收到接口文档配置请求时，按照接口文档配置请求获取目标源代码信息和目标配置模板。

可以理解的是，接口文档配置请求与目标源代码信息为一一对应关系。目标源代码信息为预先编写的包含接口类、接口参数以及接口注释的代码，例如，目标源代码信息如下所示：

其中，各字段的数据类型可以包括字符串类型string、整型int和时间类型timestamp，还可以包括其他数据类型，字符串类型还可以包括不同的数据格式的字符串，具体此处不做限定。

可选的，当服务器接收到接口文档配置请求时，对接口文档配置请求进行解析，得到目标文档标识信息和待配置文档类型；服务器按照目标文档标识信息从预设数据库中查询目标文档路径信息，并根据目标文档路径信息读取目标源代码信息，需要说明的是，服务器判断目标文档路径信息是否为空值，当目标文档路径信息不为空值时，服务器判断目标文档路径信息是否为有效路径，当目标文档路径信息为有效路径时，服务器调用文件读取函数按照目标文档路径信息从预设文件目录中读取目标源代码信息；服务器按照待配置文档类型从预设数据库中匹配目标配置模板。

202、通过预设源代码缺陷分析工具对目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对代码分析树进行静态代码分析，得到分析结果。

该步骤202与步骤102的执行过程相似，具体此处不再赘述。

203、当分析结果为未通过时，从目标源代码信息中获取异常代码信息和异常代码类型，按照异常代码类型对异常代码信息设置预警信息，并向终端发送预警信息，以使得终端提示目标用户按照预警信息对异常代码信息进行纠错处理。

该步骤203与步骤103的执行过程相似，具体此处不再赘述。

204、当分析结果为通过时，调用预设源代码解析器解析目标源代码信息，得到接口参数数据，接口参数数据包括参数名称和数据类型。

可以理解的是，目标源代码信息用于指示未编译的，并按照一定的程序设计语言规范书写的文本文件，也是一种计算机语言指令。可选的，当分析结果为通过时，服务器调用预设源代码解析器将目标源代码信息转换为目标源码树，目标源码树包括结点类型为源码的多个结点；服务器对目标源码树中的每个结点按照预设参数维度进行解析并组合，得到接口参数数据，接口参数数据包括参数名称和数据类型。其中，预设参数维度是指参数的类型属性存在不同。

具体的，服务器确定目标源代码信息中的多个功能模块；服务器解析每个功能模块对应在源码树上的每个结点，得到每个功能模块对应的接口参数数据，接口参数数据包括接口参数的参数名称和接口参数的数据类型。例如，如表1所示：

表1：接口参数数据

参数名称	数据类型	描述信息
			user_name	string	用户姓名
id_card	string	用户身份证
			create_time	object	用户创建时间

205、按照数据类型对参数名称分配对应的初始参数值，对初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对参数名称和脱敏后的参数值进行数据封装，得到响应数据。

需要说明的是，服务器对数据进行脱敏处理，提高了响应数据的安全性和可靠性。可选的，服务器按照数据类型和参数名称查询预设配置表，得到参数生成规则；服务器按照参数生成规则对参数名称动态分配初始参数值，参数名称与初始参数值具有对应关系；服务器从预设配置表中读取参数脱敏规则，并根据参数脱敏规则对初始参数值进行数据脱敏处理，得到脱敏后的参数值，参数脱敏规则为预先设置并存储在预设配置表中的规则数据；服务器按照预设数据格式将参数名称与脱敏后的参数值进行数据封装，得到响应数据，并对响应数据进行存储。其中，预设数据格式可以为JSON的数据格式，也可以为可扩展标记语言XML的数据格式，具体此处不做限定。

206、基于目标配置模板对接口参数数据和响应数据进行数据组合，得到目标文本流，并对目标文本流进行文档导出，得到接口配置文件。

也就是，接口配置文件包括接口参数数据和响应数据。可选的，服务器通过预设正则匹配规则从目标配置模板中提取待替换标签，并对待替换标签进行解析，得到解析结果，解析结果用于指示待替换数据类型，其中，预设正则匹配规则包括多个预设的正则表达式，正则表达式主要由一组描述字符串特征的字符组成；服务器获取目标源代码信息对应的接口访问地址，并按照解析结果将接口访问地址、接口参数数据和响应数据填充至目标配置模板中，得到目标文本流，进一步地，服务器将接口参数数据按照数据表格的形式进行填充；服务器按照预设命名规则将目标文本流写入至预设文件目录中，得到接口配置文件。

需要说明的是，预设命名规则可以包括文件类型、文件生成时间戳和文件前缀，以使得接口配置文件的名称具有唯一性，不存在重名覆盖，接口配置文件包括结构化的接口文档信息。

207、当接收到接口配置文件更新请求时，从接口配置文件更新请求中读取待更新参数信息、待更新接口版本号和待变更接口唯一标识。

其中，待变更接口唯一标识可以为待变更接口的接口地址信息，也可以为接口名称信息，具体此处不做限定。接口配置文件更新请求包括对接口配置文件中的接口参数数据的更新、修改和删除操作。进一步地，当服务器接收到接口配置文件更新请求时，服务器对接口配置文件更新请求进行参数解析，得到待更新参数信息、待更新接口版本号和待变更接口唯一标识。

208、按照待变更接口唯一标识获取已存储接口版本号，当已存储接口版本号与待更新接口版本号不一致时，根据待更新接口信息生成文档变更记录，并将已存储接口版本号变更为待更新接口版本号。

需要说明的是，服务器根据两个文档版本号(已存储接口版本号与待更新接口版本号)生成文档变更记录，并查询已变更接口的文档变更记录，例如，文档变更记录为新增、修改和删除文档参数的变更信息。同时服务器还可以基于已存储接口版本号与待更新接口版本号按照各自对应的接口配置文件生成接口测试页，并在终端中展示接口测试页，以使得目标用户获取并对比查看两个版本新旧接口的测试页，提高了接口测试的效率。

进一步地，当服务器接收到患者就诊记录信息查询请求时，服务器按照患者就诊记录信息查询请求查询目标接口配置文件；服务器基于目标接口配置文件生成患者就诊记录信息，并将患者就诊记录信息发送至终端。

本发明实施例中，通过预设源代码缺陷分析工具对目标源代码信息进行静态代码分析，当分析未通过时，向终端发送预警信息，以使得终端按照预警信息对异常代码信息进行纠错处理，提高了异常代码预警效率和纠错处理效率；当分析通过时，按照java标准注释进行参数解析、分类和脱敏处理后，生成一个兼容不同文件类型的接口配置文档，提高了接口文档的生成效率和接口文档的兼容性。

上面对本发明实施例中接口文档配置方法进行了描述，下面对本发明实施例中接口文档配置装置进行描述，请参阅图3，本发明实施例中接口文档配置装置的一个实施例包括：

获取模块301，当接收到接口文档配置请求时，用于按照接口文档配置请求获取目标源代码信息和目标配置模板；

分析模块302，用于通过预设源代码缺陷分析工具对目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对代码分析树进行静态代码分析，得到分析结果；

预警模块303，当分析结果为未通过时，用于从目标源代码信息中获取异常代码信息和异常代码类型，按照异常代码类型对异常代码信息设置预警信息，并向终端发送预警信息，以使得终端提示目标用户按照预警信息对异常代码信息进行纠错处理；

解析模块304，当分析结果为通过时，用于调用预设源代码解析器解析目标源代码信息，得到接口参数数据，接口参数数据包括参数名称和数据类型；

脱敏模块305，用于按照数据类型对参数名称分配对应的初始参数值，对初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对参数名称和脱敏后的参数值进行数据封装，得到响应数据；

导出模块306，用于基于目标配置模板对接口参数数据和响应数据进行数据组合，得到目标文本流，并对目标文本流进行文档导出，得到接口配置文件。

进一步地，将接口参数数据存储于区块链数据库中，具体此处不做限定。

本发明实施例中，通过预设源代码缺陷分析工具对目标源代码信息进行静态代码分析，当分析未通过时，向终端发送预警信息，以使得终端按照预警信息对异常代码信息进行纠错处理，提高了异常代码预警效率和纠错处理效率；当分析通过时，按照java标准注释进行参数解析、分类和脱敏处理后，生成一个兼容不同文件类型的接口配置文档，提高了接口文档的生成效率和接口文档的兼容性。

请参阅图4，本发明实施例中接口文档配置装置的另一个实施例包括：

获取模块301，当接收到接口文档配置请求时，用于按照接口文档配置请求获取目标源代码信息和目标配置模板；

分析模块302，用于通过预设源代码缺陷分析工具对目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对代码分析树进行静态代码分析，得到分析结果；

预警模块303，当分析结果为未通过时，用于从目标源代码信息中获取异常代码信息和异常代码类型，按照异常代码类型对异常代码信息设置预警信息，并向终端发送预警信息，以使得终端提示目标用户按照预警信息对异常代码信息进行纠错处理；

解析模块304，当分析结果为通过时，用于调用预设源代码解析器解析目标源代码信息，得到接口参数数据，接口参数数据包括参数名称和数据类型；

脱敏模块305，用于按照数据类型对参数名称分配对应的初始参数值，对初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对参数名称和脱敏后的参数值进行数据封装，得到响应数据；

导出模块306，用于基于目标配置模板对接口参数数据和响应数据进行数据组合，得到目标文本流，并对目标文本流进行文档导出，得到接口配置文件。

可选的，获取模块301还可以具体用于：

当接收到接口文档配置请求时，对接口文档配置请求进行解析，得到目标文档标识信息和待配置文档类型；

按照目标文档标识信息从预设数据库中查询目标文档路径信息，并根据目标文档路径信息读取目标源代码信息；

按照待配置文档类型从预设数据库中匹配目标配置模板。

可选的，解析模块304还可以具体用于：

当分析结果为通过时，调用预设源代码解析器将目标源代码信息转换为目标源码树，目标源码树包括结点类型为源码的多个结点；

对目标源码树中的每个结点按照预设参数维度进行解析并组合，得到接口参数数据，接口参数数据包括参数名称和数据类型。

可选的，脱敏模块305还可以具体用于：

按照数据类型和参数名称查询预设配置表，得到参数生成规则；

按照参数生成规则对参数名称动态分配初始参数值，参数名称与初始参数值具有对应关系；

从预设配置表中读取参数脱敏规则，并根据参数脱敏规则对初始参数值进行数据脱敏处理，得到脱敏后的参数值；

按照预设数据格式将参数名称与脱敏后的参数值进行数据封装，得到响应数据，并对响应数据进行存储。

可选的，导出模块306还可以具体用于：

通过预设正则匹配规则从目标配置模板中提取待替换标签，并对待替换标签进行解析，得到解析结果，解析结果用于指示待替换数据类型；

获取目标源代码信息对应的接口访问地址，并按照解析结果将接口访问地址、接口参数数据和响应数据填充至目标配置模板中，得到目标文本流；

按照预设命名规则将目标文本流写入至预设文件目录中，得到接口配置文件。

可选的，接口文档配置装置还包括：

读取模块307，当接收到接口配置文件更新请求时，用于从接口配置文件更新请求中读取待更新参数信息、待更新接口版本号和待变更接口唯一标识；

变更模块308，用于按照待变更接口唯一标识获取已存储接口版本号，当已存储接口版本号与待更新接口版本号不一致时，根据待更新接口信息生成文档变更记录，并将已存储接口版本号变更为待更新接口版本号。

可选的，接口文档配置装置还包括：

查询模块309，当接收到患者就诊记录信息查询请求时，用于按照患者就诊记录信息查询请求查询目标接口配置文件；

生成模块310，用于基于目标接口配置文件生成患者就诊记录信息，并将患者就诊记录信息发送至终端。

本发明实施例中，通过预设源代码缺陷分析工具对目标源代码信息进行静态代码分析，当分析未通过时，向终端发送预警信息，以使得终端按照预警信息对异常代码信息进行纠错处理，提高了异常代码预警效率和纠错处理效率；当分析通过时，按照java标准注释进行参数解析、分类和脱敏处理后，生成一个兼容不同文件类型的接口配置文档，提高了接口文档的生成效率和接口文档的兼容性。

上面图3和图4从模块化的角度对本发明实施例中的接口文档配置装置进行详细描述，下面从硬件处理的角度对本发明实施例中接口文档配置设备进行详细描述。

图5是本发明实施例提供的一种接口文档配置设备的结构示意图，该接口文档配置设备500可因配置或性能不同而产生比较大的差异，可以包括一个或一个以上处理器(central processing units，CPU)510(例如，一个或一个以上处理器)和存储器520，一个或一个以上存储应用程序533或数据532的存储介质530(例如一个或一个以上海量存储设备)。其中，存储器520和存储介质530可以是短暂存储或持久存储。存储在存储介质530的程序可以包括一个或一个以上模块(图示没标出)，每个模块可以包括对接口文档配置设备500中的一系列指令操作。更进一步地，处理器510可以设置为与存储介质530通信，在接口文档配置设备500上执行存储介质530中的一系列指令操作。

接口文档配置设备500还可以包括一个或一个以上电源540，一个或一个以上有线或无线网络接口550，一个或一个以上输入输出接口560，和/或，一个或一个以上操作系统531，例如Windows Serve，Mac OS X，Unix，Linux，FreeBSD等等。本领域技术人员可以理解，图5示出的接口文档配置设备结构并不构成对接口文档配置设备的限定，可以包括比图示更多或更少的部件，或者组合某些部件，或者不同的部件布置。

本发明还提供一种计算机可读存储介质，该计算机可读存储介质可以为非易失性计算机可读存储介质，该计算机可读存储介质也可以为易失性计算机可读存储介质，所述计算机可读存储介质中存储有指令，当所述指令在计算机上运行时，使得计算机执行所述接口文档配置方法的步骤。

本发明还提供一种接口文档配置设备，所述接口文档配置设备包括存储器和处理器，存储器中存储有指令，所述指令被处理器执行时，使得处理器执行上述各实施例中的所述接口文档配置方法的步骤。

进一步地，所述计算机可读存储介质可主要包括存储程序区和存储数据区，其中，存储程序区可存储操作系统、至少一个功能所需的应用程序等；存储数据区可存储根据区块链节点的使用所创建的数据等。

本发明所指区块链是分布式数据存储、点对点传输、共识机制、加密算法等计算机技术的新型应用模式。区块链(Blockchain)，本质上是一个去中心化的数据库，是一串使用密码学方法相关联产生的数据块，每一个数据块中包含了一批次网络交易的信息，用于验证其信息的有效性(防伪)和生成下一个区块。区块链可以包括区块链底层平台、平台产品服务层以及应用服务层等。

所属领域的技术人员可以清楚地了解到，为描述的方便和简洁，上述描述的系统，装置和单元的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。

所述集成的单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的全部或部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本发明各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(read-only memory，ROM)、随机存取存储器(random access memory，RAM)、磁碟或者光盘等各种可以存储程序代码的介质。

以上所述，以上实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。

Claims (10)

1.一种接口文档配置方法，其特征在于，所述接口文档配置方法包括：

当接收到接口文档配置请求时，按照所述接口文档配置请求获取目标源代码信息和目标配置模板；

通过预设源代码缺陷分析工具对所述目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对所述代码分析树进行静态代码分析，得到分析结果；

当所述分析结果为未通过时，从所述目标源代码信息中获取异常代码信息和异常代码类型，按照所述异常代码类型对所述异常代码信息设置预警信息，并向终端发送所述预警信息，以使得所述终端提示目标用户按照所述预警信息对所述异常代码信息进行纠错处理；

当所述分析结果为通过时，调用预设源代码解析器解析所述目标源代码信息，得到接口参数数据，所述接口参数数据包括参数名称和数据类型；

按照所述数据类型对所述参数名称分配对应的初始参数值，对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对所述参数名称和所述脱敏后的参数值进行数据封装，得到响应数据；

基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件。

2.根据权利要求1所述的接口文档配置方法，其特征在于，所述当接收到接口文档配置请求时，按照所述接口文档配置请求获取目标源代码信息和目标配置模板，包括：

当接收到接口文档配置请求时，对所述接口文档配置请求进行解析，得到目标文档标识信息和待配置文档类型；

按照所述目标文档标识信息从预设数据库中查询目标文档路径信息，并根据所述目标文档路径信息读取目标源代码信息；

按照所述待配置文档类型从所述预设数据库中匹配目标配置模板。

3.根据权利要求1所述的接口文档配置方法，其特征在于，所述当所述分析结果为通过时，调用预设源代码解析器解析所述目标源代码信息，得到接口参数数据，所述接口参数数据包括参数名称和数据类型，包括：

当所述分析结果为通过时，调用预设源代码解析器将所述目标源代码信息转换为目标源码树，所述目标源码树包括结点类型为源码的多个结点；

对所述目标源码树中的每个结点按照预设参数维度进行解析并组合，得到接口参数数据，所述接口参数数据包括参数名称和数据类型。

4.根据权利要求1所述的接口文档配置方法，其特征在于，所述按照所述数据类型对所述参数名称分配对应的初始参数值，对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对所述参数名称和所述脱敏后的参数值进行数据封装，得到响应数据，包括：

按照所述数据类型和所述参数名称查询预设配置表，得到参数生成规则；

按照所述参数生成规则对所述参数名称动态分配初始参数值，所述参数名称与所述初始参数值具有对应关系；

从所述预设配置表中读取参数脱敏规则，并根据所述参数脱敏规则对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值；

按照预设数据格式将所述参数名称与所述脱敏后的参数值进行数据封装，得到响应数据，并对所述响应数据进行存储。

5.根据权利要求1所述的接口文档配置方法，其特征在于，所述基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件，包括：

通过预设正则匹配规则从所述目标配置模板中提取待替换标签，并对所述待替换标签进行解析，得到解析结果，所述解析结果用于指示待替换数据类型；

获取所述目标源代码信息对应的接口访问地址，并按照所述解析结果将所述接口访问地址、所述接口参数数据和所述响应数据填充至所述目标配置模板中，得到目标文本流；

按照预设命名规则将所述目标文本流写入至预设文件目录中，得到接口配置文件。

6.根据权利要求1-5中任意一项所述的接口文档配置方法，其特征在于，在所述基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件之后，所述接口文档配置方法还包括：

当接收到接口配置文件更新请求时，从所述接口配置文件更新请求中读取待更新参数信息、待更新接口版本号和待变更接口唯一标识；

按照所述待变更接口唯一标识获取已存储接口版本号，当所述已存储接口版本号与所述待更新接口版本号不一致时，根据所述待更新接口信息生成文档变更记录，并将所述已存储接口版本号变更为所述待更新接口版本号。

7.根据权利要求1-5中任意一项所述的接口文档配置方法，其特征在于，在所述基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件之后，所述接口文档配置方法还包括：

当接收到患者就诊记录信息查询请求时，按照所述患者就诊记录信息查询请求查询目标接口配置文件；

基于所述目标接口配置文件生成患者就诊记录信息，并将所述患者就诊记录信息发送至所述终端。

8.一种接口文档配置装置，其特征在于，所述接口文档配置装置包括：

获取模块，当接收到接口文档配置请求时，用于按照所述接口文档配置请求获取目标源代码信息和目标配置模板；

分析模块，用于通过预设源代码缺陷分析工具对所述目标源代码信息进行分析并构建代码分析树，按照预设源代码语法检测规则对所述代码分析树进行静态代码分析，得到分析结果；

预警模块，当所述分析结果为未通过时，用于从所述目标源代码信息中获取异常代码信息和异常代码类型，按照所述异常代码类型对所述异常代码信息设置预警信息，并向终端发送所述预警信息，以使得所述终端提示目标用户按照所述预警信息对所述异常代码信息进行纠错处理；

解析模块，当所述分析结果为通过时，用于调用预设源代码解析器解析所述目标源代码信息，得到接口参数数据，所述接口参数数据包括参数名称和数据类型；

脱敏模块，用于按照所述数据类型对所述参数名称分配对应的初始参数值，对所述初始参数值进行数据脱敏处理，得到脱敏后的参数值，并对所述参数名称和所述脱敏后的参数值进行数据封装，得到响应数据；

导出模块，用于基于所述目标配置模板对所述接口参数数据和所述响应数据进行数据组合，得到目标文本流，并对所述目标文本流进行文档导出，得到接口配置文件。

9.一种接口文档配置设备，其特征在于，所述接口文档配置设备包括：存储器和至少一个处理器，所述存储器中存储有指令；

所述至少一个处理器调用所述存储器中的所述指令，以使得所述接口文档配置设备执行如权利要求1-7中任意一项所述的接口文档配置方法。

10.一种计算机可读存储介质，其上存储有指令，其特征在于，所述指令被处理器执行时实现如权利要求1-7中任意一项所述的接口文档配置方法。

Images