An interface description file processing method, device, system, equipment and medium

Abstract

The present disclosure provides an interface description file processing method, device, system, equipment and medium, which can detect whether an interface description file database receives a target interface description file including a plurality of first interface protocols, if yes, obtain a header file including a plurality of second interface protocols at this moment, perform quality detection on the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols, if the quality detection result is passed, the quality detection result can be sent to the interface description file database, so that the interface description file database can combine the plurality of first interface protocols to obtain a new header file. In this way, the interface protocol can be detected before combination, and comparison can be combined with the header file, so that the quality detection of the interface protocol mainly based on compatibility detection can be performed, so as to solve the detected problems, improve the comprehensiveness of the detection result, ensure the accuracy of the interface, and effectively reduce the workload brought by subsequent testing.

Description

Technical Field

[0001] This disclosure relates to the field of computer technology, and more specifically, to an interface description file processing method, apparatus, system, device, and medium. Background Technology

[0002] With the advancement and development of technology, the requirements for software development are also increasing. Continuous Integration (CI) processes are widely used in software development and application delivery. Typically, in software development using CI processes, multiple developers are responsible for a portion of the same development task, and then the work of each developer is aggregated.

[0003] Taking Interface Description Language (IDL) in software as an example, whether in software development, modification, or version upgrade, it usually requires the collaboration of multiple people. Each person is responsible for a part of the coding task, and then the IDL files written by each person are uploaded to the database for integration. Although this can speed up the development process and shorten the development cycle, when problems occur, it is usually necessary to test the entire IDL and find out the problems one by one. The problem finding time is long, the problem solving cost is high, and it may even lead to a longer development cycle and reduced development efficiency. Summary of the Invention

[0004] This disclosure provides at least one method, apparatus, system, device, and storage medium for processing interface description files.

[0005] This disclosure provides an interface description file processing method, the method comprising:

[0006] The system detects whether the interface description file database has received the target interface description file, wherein the target interface description file includes multiple first interface protocols;

[0007] If so, obtain the header file of the interface description file database when the target interface description file is received, wherein the header file is the file to be merged into the target interface description file, and the header file includes multiple second interface protocols;

[0008] Based on the plurality of first interface protocols and the plurality of second interface protocols, the target interface description file is subjected to quality detection to obtain the quality detection result of the target interface description file;

[0009] If the quality inspection result indicates that the target interface description file passes the quality inspection, the quality inspection result is sent to the interface description file database to allow the interface description file database to merge the multiple first interface protocols into a new header file.

[0010] In one optional implementation, the quality inspection result includes semantic inspection result and compatibility inspection result. The step of performing quality inspection on the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols to obtain the quality inspection result of the target interface description file includes:

[0011] The plurality of first interface protocols are parsed to generate a first abstract syntax tree for the target interface description file;

[0012] Based on the first abstract syntax tree, determine the semantic detection result of the target interface description file;

[0013] The syntax of the plurality of second interface protocols is parsed to generate the second abstract syntax tree of the header file;

[0014] The first abstract syntax tree and the second abstract syntax tree are matched to obtain the compatibility detection result of the target interface description file.

[0015] In an optional implementation, the quality detection result further includes a syntax detection result, and the method further includes:

[0016] In the process of parsing the multiple first interface protocols to generate the first abstract syntax tree, if the first abstract syntax tree cannot be generated, it is determined that the syntax detection of the target interface description file fails; if the first abstract syntax tree can be generated, it is determined that the syntax detection of the target interface description file passes. The syntax detection result includes syntax detection failure and syntax detection success.

[0017] In one optional implementation, determining the semantic detection result of the target interface description file based on the first abstract syntax tree includes:

[0018] Traverse multiple first nodes of the first abstract syntax tree. If there are at least two conflicting nodes among the multiple first nodes, determine that the semantic detection of the target interface description file fails. Otherwise, determine that the semantic detection of the target interface description file passes. The semantic detection result includes semantic detection failure and semantic detection success, wherein the interface content corresponding to the two conflicting nodes conflicts with each other.

[0019] In one optional implementation, the step of matching the first abstract syntax tree and the second abstract syntax tree to obtain the compatibility detection result of the target interface description file includes:

[0020] The first abstract syntax tree includes multiple first nodes, and the second abstract syntax tree includes multiple second nodes. If no second node that matches the first node can be found among the multiple second nodes, the compatibility test of the target interface description file is determined to be unsuccessful. Otherwise, the compatibility test of the target interface description file is determined to be successful. The compatibility test result includes compatibility test failure and compatibility test success.

[0021] In an optional implementation, when the quality inspection result includes syntax inspection result, semantic inspection result, and compatibility inspection result, the following steps are used to determine that the quality inspection result indicates that the target interface description file has passed the quality inspection:

[0022] If the syntax detection result is "grammar detection passed", the semantic detection result is "semantic detection passed", and the compatibility detection result is "compatibility detection passed", then the quality detection result indicates that the target interface description file has passed the quality detection.

[0023] In an optional implementation, after performing quality detection on the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols to obtain the quality detection result of the target interface description file, the method further includes:

[0024] If the quality inspection result indicates that the target interface description file has failed the quality inspection, based on the quality inspection result, at least one target interface protocol among the plurality of first interface protocols that has failed the quality inspection is determined;

[0025] The at least one target interface protocol is sent to the interface description file database to allow the interface description file database to merge other first interface protocols besides the at least one target interface protocol into the plurality of second interface protocols.

[0026] In an optional implementation, after determining at least one target interface protocol among the plurality of first interface protocols that failed the quality test based on the quality test result if the quality test result indicates that the target interface description file has failed the quality test, the method includes:

[0027] The test results of at least one target interface protocol in the quality test results are displayed to the user.

[0028] This disclosure also provides an interface description file processing apparatus, the apparatus comprising:

[0029] The file detection module is used to detect whether the interface description file database has received the target interface description file, wherein the target interface description file includes multiple first interface protocols;

[0030] The file acquisition module is used to acquire, if yes, the header file of the interface description file database when the target interface description file is received, wherein the header file is the file to be merged into the target interface description file, and the header file includes multiple second interface protocols;

[0031] The quality inspection module is used to perform quality inspection on the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols, and obtain the quality inspection result of the target interface description file;

[0032] The first processing module is configured to send the quality detection result to the interface description file database if the quality detection result indicates that the target interface description file has passed the quality detection, so as to allow the interface description file database to merge the multiple first interface protocols into a new header file.

[0033] In one optional implementation, the quality detection result includes semantic detection result and compatibility detection result, and the quality detection module is specifically used for:

[0034] The plurality of first interface protocols are parsed to generate a first abstract syntax tree for the target interface description file;

[0035] Based on the first abstract syntax tree, determine the semantic detection result of the target interface description file;

[0036] The syntax of the plurality of second interface protocols is parsed to generate the second abstract syntax tree of the header file;

[0037] The first abstract syntax tree and the second abstract syntax tree are matched to obtain the compatibility detection result of the target interface description file.

[0038] In an optional implementation, the quality detection result further includes a syntax detection result, and the quality detection module is further configured to:

[0039] In the process of parsing the multiple first interface protocols to generate the first abstract syntax tree, if the first abstract syntax tree cannot be generated, it is determined that the syntax detection of the target interface description file fails; if the first abstract syntax tree can be generated, it is determined that the syntax detection of the target interface description file passes. The syntax detection result includes syntax detection failure and syntax detection success.

[0040] In an optional implementation, when the quality detection module determines the semantic detection result of the target interface description file based on the first abstract syntax tree, it is specifically used for:

[0041] Traverse multiple first nodes of the first abstract syntax tree. If there are at least two conflicting nodes among the multiple first nodes, determine that the semantic detection of the target interface description file fails. Otherwise, determine that the semantic detection of the target interface description file passes. The semantic detection result includes semantic detection failure and semantic detection success, wherein the interface content corresponding to the two conflicting nodes conflicts with each other.

[0042] In an optional implementation, when the quality detection module matches the first abstract syntax tree and the second abstract syntax tree to obtain the compatibility detection result of the target interface description file, it is specifically used for:

[0043] The first abstract syntax tree includes multiple first nodes, and the second abstract syntax tree includes multiple second nodes. If no second node that matches the first node can be found among the multiple second nodes, the compatibility test of the target interface description file is determined to be unsuccessful. Otherwise, the compatibility test of the target interface description file is determined to be successful. The compatibility test result includes compatibility test failure and compatibility test success.

[0044] In an optional implementation, when the quality inspection result includes syntax inspection result, semantic inspection result, and compatibility inspection result, the first processing module is configured to determine, through the following steps, that the quality inspection result indicates the target interface description file has passed the quality inspection:

[0045] If the syntax detection result is "grammar detection passed", the semantic detection result is "semantic detection passed", and the compatibility detection result is "compatibility detection passed", then the quality detection result indicates that the target interface description file has passed the quality detection.

[0046] In one optional embodiment, the apparatus further includes a second processing module, the second processing module being used for:

[0047] If the quality inspection result indicates that the target interface description file has failed the quality inspection, based on the quality inspection result, at least one target interface protocol among the plurality of first interface protocols that has failed the quality inspection is determined;

[0048] The at least one target interface protocol is sent to the interface description file database to allow the interface description file database to merge other first interface protocols besides the at least one target interface protocol into the plurality of second interface protocols.

[0049] In an optional implementation, the second processing module is further configured to:

[0050] The test results of at least one target interface protocol in the quality test results are displayed to the user.

[0051] This disclosure also provides an interface description file processing system, the system including an interface description file database and the aforementioned interface description file processing device, wherein the interface description file processing device is pre-installed by the user in the interface description file database.

[0052] This disclosure also provides an electronic device, including: a processor, a memory, and a bus. The memory stores machine-readable instructions executable by the processor. When the electronic device is running, the processor communicates with the memory via the bus. When the machine-readable instructions are executed by the processor, the steps of the interface description file processing method described above are performed.

[0053] This disclosure also provides a computer-readable storage medium storing a computer program, which, when executed by a processor, performs the steps of the above-described file processing method.

[0054] The file processing method, apparatus, system, device, and medium provided in this disclosure can detect whether the interface description file database has received a target interface description file including multiple first interface protocols. If so, it obtains a header file including multiple second interface protocols at this time, performs quality detection on the target interface description file based on the multiple first interface protocols and the multiple second interface protocols, and obtains the quality detection result. If the quality detection result is that the quality detection is passed, the quality detection result can be sent to the interface description file database to allow the interface description file database to merge the multiple first interface protocols to obtain a new header file.

[0055] In this way, the interface protocol can be tested before integration, and the header file can be compared to perform quality testing, mainly for compatibility, in order to resolve the detected problems, improve the comprehensiveness of the test results, ensure the accuracy of the interface, and effectively reduce the workload of subsequent testing.

[0056] Furthermore, by performing quality testing, especially compatibility testing, on the interface protocol, the reliance on testing can be effectively reduced, thereby avoiding online incidents caused by incomplete test case coverage.

[0057] To make the above-mentioned objects, features and advantages of this disclosure more apparent and understandable, preferred embodiments are described below in detail with reference to the accompanying drawings. Attached Figure Description

[0058] To more clearly illustrate the technical solutions of the embodiments of this disclosure, the accompanying drawings used in the embodiments will be briefly described below. These drawings are incorporated in and constitute a part of this specification. They illustrate embodiments conforming to this disclosure and, together with the specification, serve to explain the technical solutions of this disclosure. It should be understood that the following drawings only show some embodiments of this disclosure and should not be considered as limiting the scope. Those skilled in the art can obtain other related drawings based on these drawings without creative effort.

[0059] Figure 1 This illustration shows an application scenario diagram of an interface description file processing method provided in an embodiment of the present disclosure;

[0060] Figure 2 A flowchart of an interface description file processing method provided in an embodiment of this disclosure is shown;

[0061] Figure 3 A flowchart illustrating another interface description file processing method provided by an embodiment of this disclosure is shown;

[0062] Figure 4 A timing diagram of an interface description file processing method provided in an embodiment of this disclosure is shown;

[0063] Figure 5 The flowchart illustrates a specific method for quality detection in an interface description file processing method provided in this embodiment of the present disclosure.

[0064] Figure 6 This illustration shows one of the schematic diagrams of an interface description file processing apparatus provided in an embodiment of the present disclosure;

[0065] Figure 7A second schematic diagram of an interface description file processing apparatus provided in an embodiment of this disclosure is shown;

[0066] Figure 8 A schematic diagram of an electronic device provided in the embodiments of this disclosure is shown. Detailed Implementation

[0067] To make the objectives, technical solutions, and advantages of the embodiments of this disclosure clearer, the technical solutions of the embodiments of this disclosure will be clearly and completely described below with reference to the accompanying drawings. Obviously, the described embodiments are only a part of the embodiments of this disclosure, and not all of them. The components of the embodiments of this disclosure described and shown in the accompanying drawings can generally be arranged and designed in various different configurations. Therefore, the following detailed description of the embodiments of this disclosure provided in the accompanying drawings is not intended to limit the scope of the claimed disclosure, but merely represents selected embodiments of this disclosure. All other embodiments obtained by those skilled in the art based on the embodiments of this disclosure without inventive effort are within the scope of protection of this disclosure.

[0068] It should be noted that similar labels and letters in the following figures indicate similar items. Therefore, once an item is defined in one figure, it does not need to be further defined and explained in subsequent figures.

[0069] In this document, the term "and / or" merely describes a relationship, indicating that three relationships can exist. For example, A and / or B can represent three cases: A alone, A and B simultaneously, and B alone. Furthermore, the term "at least one" in this document means any combination of at least two of any one or more elements. For example, including at least one of A, B, and C can mean including any one or more elements selected from the set consisting of A, B, and C.

[0070] Research has shown that with the advancement and development of technology, the requirements for software development are also increasing. Continuous Integration (CI) processes are widely used in software development and application delivery. Typically, in software development using CI processes, multiple developers are responsible for a portion of the development task at the same stage, and then their work is aggregated. Taking Interface Description Language (IDL) as an example, whether in software development, modification, or version upgrades, collaboration is often required. Each person is responsible for a portion of the coding task, and then their IDL files are uploaded to a database for integration. While this can speed up the development process and shorten the development cycle, when problems arise, it often requires testing the entire IDL and identifying issues one by one. This problem-solving process is time-consuming and costly, and can even extend the development cycle and reduce development efficiency.

[0071] Based on the above research, this disclosure provides an interface description file processing method, which can detect whether the interface description file database has received a target interface description file including multiple first interface protocols. If so, it obtains the header file including multiple second interface protocols at this time, performs quality detection on the target interface description file based on the multiple first interface protocols and the multiple second interface protocols, and obtains the quality detection result. If the quality detection result is that the quality detection is passed, the quality detection result can be sent to the interface description file database to allow the interface description file database to merge the multiple first interface protocols to obtain a new header file.

[0072] In this way, the interface protocol can be tested before integration, and the header file can be compared to perform quality testing, mainly for compatibility, in order to resolve the detected problems, improve the comprehensiveness of the test results, ensure the accuracy of the interface, and effectively reduce the workload of subsequent testing.

[0073] Furthermore, by performing quality testing, especially compatibility testing, on the interface protocol, the reliance on testing can be effectively reduced, thereby avoiding online incidents caused by incomplete test case coverage.

[0074] The shortcomings of the above solutions are the result of the inventor's practical experience and careful research. Therefore, the discovery process of the above problems and the solutions proposed in this disclosure below should be considered as the inventor's contribution to this disclosure.

[0075] To facilitate understanding of this embodiment, a detailed description of the interface description file processing method disclosed in this disclosure will be provided first. The execution entity of the interface description file processing method provided in this disclosure is generally a computer device with certain computing capabilities, such as a terminal device, a server, or other processing devices. In some possible implementations, the interface description file processing method can be implemented by a processor calling computer-readable instructions stored in memory.

[0076] The following describes the interface description file processing method provided in this embodiment, taking the server as the execution subject as an example.

[0077] Please see Figure 1 , Figure 1 This diagram illustrates an application scenario of an interface description file processing method provided in this embodiment of the disclosure. Figure 1 As shown, the application scenario of the interface description file processing method includes an interface description file processing system and a terminal that can communicate with the interface description file processing system. The interface description file processing system includes an interface description file database and an interface description file processing device; the interface description file database manages the interface description files.

[0078] The interface description file here can be an IDL file. An IDL file is used to describe the interface information exposed by the service. The interface information may include interface methods, interface paths, request parameters, return parameters, etc. Based on the interface information described in the IDL file, the corresponding interface protocol can be applied for development.

[0079] When users conduct business development on the terminal, they can use the software development tools installed on the terminal to write interface description files, and then upload the completed interface description files to the interface description file processing system, which in turn uploads the interface description files to the interface description file database.

[0080] The interface description file processing device is pre-installed by the user in the interface description file database, enabling the interface description file database to be configured with the interface description file processing device. Furthermore, the interface description file database configured with the interface description file processing device can have a checkpoint function. After the interface description file processing system uploads an interface description file to the interface description file database, based on the checkpoint function, the interface description file database can forward the interface description file to the interface description file processing device. The interface description file processing device can then detect and process the interface description file, meaning it can detect and process the interface description file uploaded by the user.

[0081] It is understood that the interface description file processing device is pre-installed by the user in the interface description file database. Specifically, the interface description file processing device can be embedded in the interface description file database or set outside the interface description file database, as long as it can achieve a communication connection with the interface description file database.

[0082] The interface description file processing device can inspect the interface description file. Only after passing the inspection is the interface description file allowed to be merged into the interface description file database. Correspondingly, the processing result of the interface description file processing device is also sent to the terminal, for example, displayed through the user terminal's software development tool, so that the user can make corresponding modifications to the interface description file. The software development tool can be part of the interface description file processing device presented on the front end; that is, the interface description file processing device includes the software development tool.

[0083] It is understood that the interface description file processing device only needs to be pre-installed by the user in the interface description file database. It is easy to operate, has low access cost, and can perform quality inspection before the interface description file is merged into the interface description file database, thereby ensuring R&D quality and shortening the R&D cycle.

[0084] Please also refer to Figure 2 , Figure 2 A flowchart illustrating an interface description file processing method provided in this embodiment of the disclosure. Figure 2 As shown in the embodiments of this disclosure, the interface description file processing method includes:

[0085] S201: Detect whether the interface description file database has received the target interface description file, wherein the target interface description file includes multiple first interface protocols.

[0086] In this step, when the user develops the target interface description file on the terminal side, they can use, for example... Figure 1 The software development tool shown here, in this case, the target interface description file received may refer to the target interface description file uploaded by the user through the software development tool. Additionally, when the user submits the target interface description file through other means... Figure 1 In the case of uploading a target interface description file to the database as shown, receiving the target interface description file can mean that after receiving the target interface description file, the database sends the target interface description file to... Figure 1The interface description file processing device shown is pre-installed by the user in the interface description file database, thus configuring the interface description file database with the processing device. Furthermore, the interface description file database configured with the processing device can have a checkpoint function. Therefore, when the interface description file database receives the target interface description file, based on the checkpoint function, the database can forward the target interface description file to the processing device for further processing.

[0087] The checkpoint function can be either the interface description file processing device actively detecting whether the interface description file database has received the target interface description file, or it can be triggered when the interface description file database receives the target interface description file, thereby causing the interface description file processing device to passively detect whether the interface description file database has received the target interface description file.

[0088] Multiple users can upload files to the same interface description file database, and the same interface description file database can receive multiple files uploaded by different users, without any limitation.

[0089] S202: If so, obtain the header file of the interface description file database when the target interface description file is received, wherein the header file is the file to be merged into the target interface description file, and the header file includes multiple second interface protocols.

[0090] In this step, in order to merge the target interface description file later, when the target interface description file database is detected to have received the target interface description file, the time when the target interface description file is received can be determined so as to extract the header file corresponding to that time from the interface description file database.

[0091] In the interface description file database, for the header file, each time the target interface description file is received, the version of the header file can be changed. With the accumulation of time and version iterations, the header file may have multiple versions. Therefore, in order to ensure the accuracy of subsequent quality detection, the timing of obtaining the header file can be the moment when the target interface description file is received.

[0092] S203: Based on the plurality of first interface protocols and the plurality of second interface protocols, perform quality inspection on the target interface description file to obtain the quality inspection result of the target interface description file.

[0093] In this step, in order to determine the subsequent processing method for the target interface description file, the target interface description file can be subjected to quality inspection. The object of the quality inspection is the interface protocol. By performing quality inspection on the multiple first interface protocols and the multiple second interface protocols, the quality inspection result of the target interface description file can be obtained.

[0094] The quality inspection includes, but is not limited to, inspecting the syntax, semantics, compatibility, business functions, business rules, attribute parameters, performance indicators, and security indicators of the interface protocol.

[0095] S204: If the quality inspection result indicates that the target interface description file has passed the quality inspection, the quality inspection result is sent to the interface description file database to allow the interface description file database to merge the multiple first interface protocols into a new header file.

[0096] In this step, if the quality inspection result indicates that the target interface description file has passed the quality inspection, the quality inspection result can be sent to the interface description file database. The interface description file database updates the interface protocols in the database by merging the multiple first interface protocols into the multiple second interface protocols, that is, by merging the target interface description file into the header file. In other words, a new header file is generated based on the merging result. Furthermore, the new header file can be saved in the interface description file database for use in the next quality inspection.

[0097] If the quality inspection includes multiple inspections, and the result of each inspection is "pass", the quality inspection result indicates that the target interface description file has passed the quality inspection.

[0098] The interface description file processing method provided in this embodiment can detect whether the interface description file database has received a target interface description file including multiple first interface protocols. If so, it obtains a header file including multiple second interface protocols at this time, performs quality detection on the target interface description file based on the multiple first interface protocols and the multiple second interface protocols, and obtains the quality detection result. If the quality detection result is that the quality detection is passed, the quality detection result can be sent to the interface description file database to allow the interface description file database to merge the multiple first interface protocols to obtain a new header file.

[0099] In this way, the interface protocol can be tested before integration, and the header file can be compared to perform quality testing, mainly for compatibility, in order to resolve the detected problems, improve the comprehensiveness of the test results, ensure the accuracy of the interface, and effectively reduce the workload of subsequent testing.

[0100] Furthermore, by performing quality testing, especially compatibility testing, on the interface protocol, the reliance on testing can be effectively reduced, thereby avoiding online incidents caused by incomplete test case coverage.

[0101] Please see Figure 3 , Figure 3 A flowchart illustrating another interface description file processing method provided in this disclosure embodiment. For example... Figure 3 As shown in the embodiments of this disclosure, the interface description file processing method includes:

[0102] S301: Detect whether the interface description file database has received the target interface description file, wherein the target interface description file includes multiple first interface protocols.

[0103] S302: If so, obtain the header file of the interface description file database when the target interface description file is received, wherein the header file is the file to be merged into the target interface description file, and the header file includes multiple second interface protocols.

[0104] S303: Based on the plurality of first interface protocols and the plurality of second interface protocols, perform quality inspection on the target interface description file to obtain the quality inspection result of the target interface description file.

[0105] The descriptions of steps S301 to S303 can refer to the descriptions of steps S201 to S203, and can achieve the same technical effect and solve the same technical problem, so they will not be repeated here.

[0106] S304: If the quality inspection result indicates that the target interface description file has failed the quality inspection, based on the quality inspection result, determine at least one target interface protocol among the plurality of first interface protocols that has failed the quality inspection.

[0107] In this step, if the quality inspection result indicates that the target interface description file has failed the quality inspection, the quality inspection result may include the inspection result for each first interface protocol, that is, whether each first interface protocol has passed the quality inspection. Therefore, at least one target interface protocol that has failed the quality inspection can be determined from the plurality of first interface protocols.

[0108] S305: Send the at least one target interface protocol to the interface description file database to allow the interface description file database to merge other first interface protocols besides the at least one target interface protocol into the plurality of second interface protocols.

[0109] To ensure the accuracy of the merged file, if the quality inspection result indicates that the target interface description file has failed the quality inspection, in some possible implementations, the quality inspection result can be sent to the interface description file database to allow the interface description file database to prohibit the merging of the multiple first interface protocols into the multiple second interface protocols, that is, to prohibit the merging of the target interface description file into the header file. Furthermore, the current header file can be considered as a new header file for use in the next quality inspection.

[0110] As can be seen from the above, if the quality inspection includes multiple inspections, and at least one inspection result is a failure, the quality inspection result indicates that the target interface description file has failed the quality inspection.

[0111] Here, if the quality detection result indicates that the target interface description file has failed the quality detection, then at least one target interface protocol among the plurality of first interface protocols has failed the quality detection. In this case, in order to ensure the validity and availability of the uploaded target interface description file, at least one target interface protocol among the plurality of first interface protocols and the other first interface protocols can be processed separately.

[0112] Accordingly, the at least one target interface protocol can be sent to the interface description file database, allowing the interface description file database to merge other first interface protocols besides the at least one target interface protocol into the multiple second interface protocols to obtain a new header file.

[0113] In order to make subsequent modifications to the target interface description file, a prompt can be given to the user for at least one target interface protocol that fails the quality test.

[0114] Specifically, if the quality inspection result indicates that the target interface description file has failed the quality inspection, and based on the quality inspection result, at least one target interface protocol among the plurality of first interface protocols has failed the quality inspection, the inspection result of the at least one target interface protocol in the quality inspection result can be displayed to the user.

[0115] In this step, for at least one target interface protocol that fails the quality inspection, the inspection result for the at least one target interface protocol in the quality inspection results can be determined and displayed to the user so that corresponding modifications can be made subsequently.

[0116] The detection result of the at least one target interface protocol may be the location information of the at least one target interface protocol or the protocol content information of the at least one target interface protocol, and no limitation is made here.

[0117] The method of displaying the prompt information to the user may be to display the prompt text or to play the prompt audio or video, and no limitation is made here.

[0118] Please also refer to Figure 4 , Figure 4 This is a timing diagram of an interface description file processing method provided in an embodiment of this disclosure. Figure 4 As shown, when a user uploads an interface description file to the interface description file database, the database is equipped with an interface description file processing device, which further enables the database to have a checkpoint function. Based on this checkpoint function, when the database receives the interface description file, it can forward it to the processing device, which can then perform quality checks on the file. If the quality check result indicates that the target interface description file passes the check, it can be merged into the database. If the result indicates that the file fails the check, it cannot be merged into the database, or only partially. The system identifies problematic interface protocols within the target file and, based on the checkpoint function, alerts the user to the detection results.

[0119] The following will further illustrate this embodiment with reference to some specific implementation methods.

[0120] In some possible implementations, the quality inspection results include semantic inspection results and compatibility inspection results. The quality inspection of the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols, to obtain the quality inspection results of the target interface description file, includes:

[0121] The plurality of first interface protocols are parsed to generate a first abstract syntax tree for the target interface description file;

[0122] Based on the first abstract syntax tree, determine the semantic detection result of the target interface description file;

[0123] The syntax of the plurality of second interface protocols is parsed to generate the second abstract syntax tree of the header file;

[0124] The first abstract syntax tree and the second abstract syntax tree are matched to obtain the compatibility detection result of the target interface description file.

[0125] In this step, if the quality detection result includes semantic detection result and compatibility detection result, the plurality of first interface protocols are parsed to generate a first abstract syntax tree of the target interface description file. Semantic detection is performed on the first abstract syntax tree to determine the semantic detection result of the target interface description file. Furthermore, the plurality of second interface protocols are parsed to generate a second abstract syntax tree of the header file. Matching the first abstract syntax tree and the second abstract syntax tree, that is, matching the plurality of first interface protocols and the plurality of second interface protocols, yields the compatibility detection result of the target interface description file.

[0126] In one possible implementation, the quality inspection result further includes a syntax inspection result, and the method further includes:

[0127] In the process of parsing the multiple first interface protocols to generate the first abstract syntax tree, if the first abstract syntax tree cannot be generated, it is determined that the syntax detection of the target interface description file fails; if the first abstract syntax tree can be generated, it is determined that the syntax detection of the target interface description file passes. The syntax detection result includes syntax detection failure and syntax detection success.

[0128] In this step, the abstract syntax tree represents the syntax structure of the programming language in a tree-like form. Therefore, the process of parsing the multiple first interface protocols to generate the first abstract syntax tree is the process of performing syntax detection on the multiple first interface protocols. If the first abstract syntax tree can be generated, it means that the target interface description file has no syntax problems, and the syntax detection passes. If the first abstract syntax tree cannot be generated, it means that the target interface description file has syntax problems, and the syntax detection fails.

[0129] For example, if a target interface description file is written entirely in C language, but an interface protocol is written in Java language, then the first abstract syntax tree cannot be generated, and the syntax check of the target interface description file is determined to be unsuccessful.

[0130] In one possible implementation, determining the semantic detection result of the target interface description file based on the first abstract syntax tree includes:

[0131] Traverse multiple first nodes of the first abstract syntax tree. If there are at least two conflicting nodes among the multiple first nodes, determine that the semantic detection of the target interface description file fails. Otherwise, determine that the semantic detection of the target interface description file passes. The semantic detection result includes semantic detection failure and semantic detection success, wherein the interface content corresponding to the two conflicting nodes conflicts with each other.

[0132] In this step, the multiple first nodes of the first abstract syntax tree include the content of various aspects of the multiple first interface protocols, such as the name, fields, rules, attributes, etc. of the first interface protocol. By traversing the multiple first nodes of the first abstract syntax tree, if it is detected that at least two of the first nodes contain non-existent or duplicate content, then the at least two first nodes are considered to be at least two conflicting nodes. The existence of at least two conflicting nodes indicates that the target interface description file has a semantic problem, and the semantic detection fails. If there are no at least two conflicting nodes, it indicates that the target interface description file does not have a semantic problem, and the semantic detection passes.

[0133] For example, if one of the plurality of first interface protocols references a non-existent name, or if protocols with the same name correspond to different protocol contents, the semantic detection of the target interface description file is determined to be unsuccessful.

[0134] In one possible implementation, matching the first abstract syntax tree and the second abstract syntax tree to obtain the compatibility detection result of the target interface description file includes:

[0135] The first abstract syntax tree includes multiple first nodes, and the second abstract syntax tree includes multiple second nodes. If no second node that matches the first node can be found among the multiple second nodes, the compatibility test of the target interface description file is determined to be unsuccessful. Otherwise, the compatibility test of the target interface description file is determined to be successful. The compatibility test result includes compatibility test failure and compatibility test success.

[0136] In this step, the multiple second nodes of the second abstract syntax tree include the contents of various aspects of the multiple second interface protocols, such as the name, fields, rules, attributes, etc. of the second interface protocols. Each first node and each second node are matched pairwise. If no second node that matches the first node can be found among the multiple second nodes, it means that the target interface description file has a compatibility problem, and the compatibility test fails. If all the multiple second nodes match the multiple first nodes, it means that the target interface description file does not have a compatibility problem, and the compatibility test passes.

[0137] For example, the compatibility issues include, but are not limited to, deleting interfaces, deleting fields, changing field names, changing field types, changing required / optional field attributes, changing field IDs, changing interfaces, adding required fields, and changing field default values.

[0138] In one possible implementation, when the quality inspection results include syntax inspection results, semantic inspection results, and compatibility inspection results, the following steps are used to determine whether the quality inspection results indicate that the target interface description file has passed the quality inspection:

[0139] If the syntax detection result is "grammar detection passed", the semantic detection result is "semantic detection passed", and the compatibility detection result is "compatibility detection passed", then the quality detection result indicates that the target interface description file has passed the quality detection.

[0140] Please also refer to Figure 5 , Figure 5 This is a flowchart illustrating a specific quality inspection method within an interface description file processing approach. For example... Figure 5As shown, the multiple first interface protocols are parsed to generate a first abstract syntax tree for the target interface description file. If parsing fails, the syntax check of the target interface description file is determined to have failed; if parsing succeeds, the syntax check of the target interface description file is determined to have passed. Then, semantic checks are performed on multiple first nodes of the first abstract syntax tree. If the check succeeds, the semantic check of the target interface description file is determined to have passed; if the check fails, the semantic check of the target interface description file is determined to have failed. The multiple second interface protocols are parsed to generate a second abstract syntax tree for the header file. Multiple first nodes of the first abstract syntax tree and multiple second nodes of the second abstract syntax tree are matched to perform compatibility checks, such as checking whether an interface has been deleted or its name has been changed. If a match is successful, the compatibility check of the target interface description file is determined to have passed; if at least one match fails, the compatibility check of the target interface description file is determined to have failed. Based on the syntax check result, semantic check result, and compatibility check result, the quality check result of the target interface description file is determined. Finally, based on the quality check result, it is determined whether the multiple first interface protocols should be merged into the multiple second interface protocols.

[0141] The interface description file processing method provided in this embodiment can detect whether the interface description file database has received a target interface description file including multiple first interface protocols. If so, it obtains a header file including multiple second interface protocols at this time, performs quality detection on the target interface description file based on the multiple first interface protocols and the multiple second interface protocols, and obtains the quality detection result. If the quality detection result is that the quality detection is passed, the quality detection result can be sent to the interface description file database to allow the interface description file database to merge the multiple first interface protocols to obtain a new header file.

[0142] In this way, the interface protocol can be tested before integration, and the header file can be compared to perform quality testing, mainly for compatibility, in order to resolve the detected problems, improve the comprehensiveness of the test results, ensure the accuracy of the interface, and effectively reduce the workload of subsequent testing.

[0143] Furthermore, by performing quality testing, especially compatibility testing, on the interface protocol, the reliance on testing can be effectively reduced, thereby avoiding online incidents caused by incomplete test case coverage.

[0144] Those skilled in the art will understand that, in the above-described method of the specific implementation, the order in which each step is written does not imply a strict execution order and does not constitute any limitation on the implementation process. The specific execution order of each step should be determined by its function and possible internal logic.

[0145] Based on the same inventive concept, this disclosure also provides an interface description file processing device corresponding to the interface description file processing method. Since the principle of the device in this disclosure for solving the problem is similar to the interface description file processing method described above in this disclosure, the implementation of the device can refer to the implementation of the method, and the repeated parts will not be described again.

[0146] Please see Figure 6 Figure 7 , Figure 6 One of the schematic diagrams of an interface description file processing device provided in this disclosure embodiment is shown below. Figure 7 This disclosure provides a second schematic diagram of an interface description file processing device. (See also...) Figure 6 As shown, the interface description file processing apparatus 600 provided in this embodiment includes:

[0147] The file detection module 610 is used to detect whether the interface description file database has received a target interface description file, wherein the target interface description file includes multiple first interface protocols;

[0148] The file acquisition module 620 is used to acquire, if yes, the header file in the interface description file database when the target interface description file is received, wherein the header file is the file to be merged into the target interface description file, and the header file includes multiple second interface protocols;

[0149] The quality inspection module 630 is used to perform quality inspection on the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols, and obtain the quality inspection result of the target interface description file.

[0150] The first processing module 640 is configured to send the quality detection result to the interface description file database if the quality detection result indicates that the target interface description file has passed the quality detection, so as to allow the interface description file database to merge the multiple first interface protocols into a new header file.

[0151] In one optional implementation, the quality detection result includes semantic detection result and compatibility detection result, and the quality detection module 630 is specifically used for:

[0152] The plurality of first interface protocols are parsed to generate a first abstract syntax tree for the target interface description file;

[0153] Based on the first abstract syntax tree, determine the semantic detection result of the target interface description file;

[0154] The syntax of the plurality of second interface protocols is parsed to generate the second abstract syntax tree of the header file;

[0155] The first abstract syntax tree and the second abstract syntax tree are matched to obtain the compatibility detection result of the target interface description file.

[0156] In an optional implementation, the quality detection result further includes a syntax detection result, and the quality detection module 630 is further configured to:

[0157] In the process of parsing the multiple first interface protocols to generate the first abstract syntax tree, if the first abstract syntax tree cannot be generated, it is determined that the syntax detection of the target interface description file fails; if the first abstract syntax tree can be generated, it is determined that the syntax detection of the target interface description file passes. The syntax detection result includes syntax detection failure and syntax detection success.

[0158] In an optional implementation, when the quality detection module 630 determines the semantic detection result of the target interface description file based on the first abstract syntax tree, it is specifically used for:

[0159] Traverse multiple first nodes of the first abstract syntax tree. If there are at least two conflicting nodes among the multiple first nodes, determine that the semantic detection of the target interface description file fails. Otherwise, determine that the semantic detection of the target interface description file passes. The semantic detection result includes semantic detection failure and semantic detection success, wherein the interface content corresponding to the two conflicting nodes conflicts with each other.

[0160] In an optional implementation, when the quality detection module 630 matches the first abstract syntax tree and the second abstract syntax tree to obtain the compatibility detection result of the target interface description file, it is specifically used for:

[0161] The first abstract syntax tree includes multiple first nodes, and the second abstract syntax tree includes multiple second nodes. If no second node that matches the first node can be found among the multiple second nodes, the compatibility test of the target interface description file is determined to be unsuccessful. Otherwise, the compatibility test of the target interface description file is determined to be successful. The compatibility test result includes compatibility test failure and compatibility test success.

[0162] In an optional implementation, when the quality inspection result includes syntax inspection result, semantic inspection result, and compatibility inspection result, the first processing module 640 is configured to determine, through the following steps, that the quality inspection result indicates the target interface description file has passed the quality inspection:

[0163] If the syntax detection result is "grammar detection passed", the semantic detection result is "semantic detection passed", and the compatibility detection result is "compatibility detection passed", then the quality detection result indicates that the target interface description file has passed the quality detection.

[0164] In one alternative implementation, such as Figure 7 As shown, the device further includes a second processing module 650, which is used for:

[0165] If the quality inspection result indicates that the target interface description file has failed the quality inspection, based on the quality inspection result, at least one target interface protocol among the plurality of first interface protocols that has failed the quality inspection is determined;

[0166] The at least one target interface protocol is sent to the interface description file database to allow the interface description file database to merge other first interface protocols besides the at least one target interface protocol into the plurality of second interface protocols.

[0167] In an optional implementation, the second processing module 650 is further configured to:

[0168] The test results of at least one target interface protocol in the quality test results are displayed to the user.

[0169] The processing flow of each module in the device and the interaction flow between each module can be referred to the relevant descriptions in the above method embodiments, and will not be detailed here.

[0170] The interface description file processing apparatus provided in this embodiment can detect whether the interface description file database has received a target interface description file including multiple first interface protocols. If so, it obtains a header file including multiple second interface protocols at this time, performs quality detection on the target interface description file based on the multiple first interface protocols and the multiple second interface protocols, and obtains the quality detection result. If the quality detection result is that the quality detection is passed, the quality detection result can be sent to the interface description file database to allow the interface description file database to merge the multiple first interface protocols to obtain a new header file.

[0171] In this way, the interface protocol can be tested before integration, and the header file can be compared to perform quality testing, mainly for compatibility, in order to resolve the detected problems, improve the comprehensiveness of the test results, ensure the accuracy of the interface, and effectively reduce the workload of subsequent testing.

[0172] Furthermore, by performing quality testing, especially compatibility testing, on the interface protocol, the reliance on testing can be effectively reduced, thereby avoiding online incidents caused by incomplete test case coverage. The interface description file processing device only needs to be pre-installed by the user in the interface description file database to complete subsequent quality testing and other processing. It has low access costs, is easy to operate, and effectively reduces the workload of R&D personnel.

[0173] This disclosure also provides an interface description file processing system, the system including an interface description file database and the aforementioned interface description file processing device, wherein the interface description file processing device is pre-installed by the user in the interface description file database.

[0174] Corresponding to the interface description file processing method described above, this disclosure also provides an electronic device 800, such as... Figure 8 The diagram shown is a structural schematic of an electronic device 800 provided in an embodiment of this disclosure, including:

[0175] The device includes a processor 810, a memory 820, and a bus 830. The memory 820 stores execution instructions and includes a main memory 821 and an external memory 822. The main memory 821, also known as internal memory, is used to temporarily store the computational data in the processor 810 and the data exchanged with external memory 822 such as a hard disk. The processor 810 exchanges data with the external memory 822 through the main memory 821. When the electronic device 800 is running, the processor 810 and the memory 820 communicate through the bus 830, enabling the processor 810 to execute the steps of the interface description file processing method described above.

[0176] This disclosure also provides a computer-readable storage medium storing a computer program, which, when executed by a processor, performs the steps of the interface description file processing method described in the above method embodiments. The storage medium can be a volatile or non-volatile computer-readable storage medium.

[0177] This disclosure also provides a computer program product, which includes computer instructions. When the computer instructions are executed by a processor, they can perform the steps of the interface description file processing method described in the above method embodiments. For details, please refer to the above method embodiments, which will not be repeated here.

[0178] The aforementioned computer program product can be implemented through hardware, software, or a combination thereof. In one optional embodiment, the computer program product is specifically embodied in a computer storage medium; in another optional embodiment, the computer program product is specifically embodied in a software product, such as a software development kit (SDK), etc.

[0179] Those skilled in the art will readily understand that, for the sake of convenience and brevity, the specific working processes of the devices, equipment, and storage media described above can be referred to the corresponding processes in the foregoing method embodiments, and will not be repeated here. In the several embodiments provided in this disclosure, it should be understood that the disclosed methods, devices, equipment, and storage media can be implemented in other ways. The device embodiments described above are merely illustrative. For example, the division of units is only a logical functional division, and in actual implementation, there may be other division methods. Furthermore, multiple units or components may be combined or integrated into another system, or some features may be ignored or not executed. Additionally, the displayed or discussed mutual coupling or direct coupling or communication connection may be through some communication interfaces; the indirect coupling or communication connection of devices or units may be electrical, mechanical, or other forms.

[0180] The units described as separate components may or may not be physically separate. The components shown as units may or may not be physical units; that is, they may be located in one place or distributed across multiple network units. Some or all of the units can be selected to achieve the purpose of this embodiment according to actual needs.

[0181] In addition, the functional units in the various embodiments of this disclosure can be integrated into one processing unit, or each unit can exist physically separately, or two or more units can be integrated into one unit.

[0182] If the aforementioned functions are implemented as software functional units and sold or used as independent products, they can be stored in a processor-executable, non-volatile, computer-readable storage medium. Based on this understanding, the technical solution of this disclosure, in essence, or the part that contributes to the prior art, or a portion of the technical solution, can be embodied in the form of a software product. This computer software product is stored in a storage medium and includes several instructions to cause a computer device (which may be a personal computer, server, or network device, etc.) to execute all or part of the steps of the methods described in the various embodiments of this disclosure. The aforementioned storage medium includes various media capable of storing program code, such as USB flash drives, portable hard drives, read-only memory (ROM), random access memory (RAM), magnetic disks, or optical disks.

[0183] Finally, it should be noted that the above-described embodiments are merely specific implementations of this disclosure, used to illustrate the technical solutions of this disclosure, and not to limit it. The protection scope of this disclosure is not limited thereto. Although this disclosure has been described in detail with reference to the foregoing embodiments, those skilled in the art should understand that any person skilled in the art can still modify or easily conceive of changes to the technical solutions described in the foregoing embodiments, or make equivalent substitutions for some of the technical features, within the scope of the technology disclosed in this disclosure. Such modifications, changes, or substitutions do not cause the essence of the corresponding technical solutions to deviate from the spirit and scope of the technical solutions of the embodiments of this disclosure, and should all be covered within the protection scope of this disclosure. Therefore, the protection scope of this disclosure should be determined by the protection scope of the claims.

Claims

1. A method for processing interface description files, characterized in that, The method includes: The system detects whether the interface description file database has received the target interface description file, wherein the target interface description file includes multiple first interface protocols; If so, obtain the header file of the interface description file database when the target interface description file is received, wherein the header file is the file to be merged into the target interface description file, and the header file includes multiple second interface protocols; Based on the plurality of first interface protocols and the plurality of second interface protocols, the target interface description file is subjected to quality detection to obtain the quality detection result of the target interface description file; If the quality inspection result indicates that the target interface description file passes the quality inspection, the quality inspection result is sent to the interface description file database, allowing the interface description file database to merge the multiple first interface protocols into a new header file. The quality inspection results include semantic inspection results and compatibility inspection results. The quality inspection of the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols, to obtain the quality inspection results of the target interface description file, includes: The plurality of first interface protocols are parsed to generate a first abstract syntax tree for the target interface description file; Based on the first abstract syntax tree, determine the semantic detection result of the target interface description file; The syntax of the plurality of second interface protocols is parsed to generate the second abstract syntax tree of the header file; The first abstract syntax tree and the second abstract syntax tree are matched to obtain the compatibility detection result of the target interface description file.

2. The method according to claim 1, characterized in that, The quality inspection results also include syntax detection results, and the method further includes: In the process of parsing the multiple first interface protocols to generate the first abstract syntax tree, if the first abstract syntax tree cannot be generated, it is determined that the syntax detection of the target interface description file fails; if the first abstract syntax tree can be generated, it is determined that the syntax detection of the target interface description file passes. The syntax detection result includes syntax detection failure and syntax detection success.

3. The method according to claim 1, characterized in that, The step of determining the semantic detection result of the target interface description file based on the first abstract syntax tree includes: Traverse multiple first nodes of the first abstract syntax tree. If there are at least two conflicting nodes among the multiple first nodes, determine that the semantic detection of the target interface description file fails. Otherwise, determine that the semantic detection of the target interface description file passes. The semantic detection result includes semantic detection failure and semantic detection success, wherein the interface content corresponding to the two conflicting nodes conflicts with each other.

4. The method according to claim 1, characterized in that, The process of matching the first abstract syntax tree and the second abstract syntax tree to obtain the compatibility detection result of the target interface description file includes: The first abstract syntax tree includes multiple first nodes, and the second abstract syntax tree includes multiple second nodes. If no second node that matches the first node can be found among the multiple second nodes, the compatibility test of the target interface description file is determined to be unsuccessful. Otherwise, the compatibility test of the target interface description file is determined to be successful. The compatibility test result includes compatibility test failure and compatibility test success.

5. The method according to claim 1, characterized in that, When the quality inspection results include syntax inspection results, semantic inspection results, and compatibility inspection results, the following steps are used to determine whether the quality inspection results indicate that the target interface description file has passed the quality inspection: If the syntax detection result is "grammar detection passed", the semantic detection result is "semantic detection passed", and the compatibility detection result is "compatibility detection passed", then the quality detection result indicates that the target interface description file has passed the quality detection.

6. The method according to claim 1, characterized in that, After performing quality detection on the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols to obtain the quality detection result of the target interface description file, the method further includes: If the quality inspection result indicates that the target interface description file has failed the quality inspection, based on the quality inspection result, at least one target interface protocol among the plurality of first interface protocols that has failed the quality inspection is determined; The at least one target interface protocol is sent to the interface description file database to allow the interface description file database to merge other first interface protocols besides the at least one target interface protocol into the plurality of second interface protocols.

7. The method according to claim 6, characterized in that, After determining, based on the quality inspection result, at least one target interface protocol among the plurality of first interface protocols that failed the quality inspection if the quality inspection result indicates that the target interface description file has failed the quality inspection, the method includes: The test results of at least one target interface protocol in the quality test results are displayed to the user.

8. An interface description file processing apparatus, characterized in that, The device includes: The file detection module is used to detect whether the interface description file database has received the target interface description file, wherein the target interface description file includes multiple first interface protocols; The file acquisition module is used to acquire, if yes, the header file of the interface description file database when the target interface description file is received, wherein the header file is the file to be merged into the target interface description file, and the header file includes multiple second interface protocols; The quality inspection module is used to perform quality inspection on the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols, and obtain the quality inspection result of the target interface description file; The first processing module is configured to, if the quality inspection result indicates that the target interface description file passes the quality inspection, send the quality inspection result to the interface description file database, so that the interface description file database can merge the multiple first interface protocols into a new header file. The quality inspection results include semantic inspection results and compatibility inspection results. The quality inspection of the target interface description file based on the plurality of first interface protocols and the plurality of second interface protocols, to obtain the quality inspection results of the target interface description file, includes: The plurality of first interface protocols are parsed to generate a first abstract syntax tree for the target interface description file; Based on the first abstract syntax tree, determine the semantic detection result of the target interface description file; The syntax of the plurality of second interface protocols is parsed to generate the second abstract syntax tree of the header file; The first abstract syntax tree and the second abstract syntax tree are matched to obtain the compatibility detection result of the target interface description file.

9. An interface description file processing system, characterized in that, The system includes an interface description file database and an interface description file processing device as described in claim 8, wherein the interface description file processing device is pre-installed by the user in the interface description file database.

10. An electronic device, characterized in that, include: The device includes a processor, a memory, and a bus. The memory stores machine-readable instructions executable by the processor. When the electronic device is running, the processor communicates with the memory via the bus. When the machine-readable instructions are executed by the processor, the steps of the interface description file processing method as described in any one of claims 1 to 7 are performed.

11. A computer-readable storage medium, characterized in that, The computer-readable storage medium stores a computer program that, when executed by a processor, performs the steps of the interface description file processing method as described in any one of claims 1 to 7.

Images