Method and system capable of automatically monitoring and updating content in combination with API (Application Program Interface)

Abstract

The invention provides a method and a system capable of automatically monitoring and updating contents in combination with an API (Application Program Interface), and belongs to the technical field of API automation. The method capable of automatically monitoring and updating contents in combination with the API comprises the following steps: accessing an entry address by virtue of a fixed Swager of each micro-service; and monitoring the interface of the existing API of the Swagger and synchronously updating the content through timed task or event triggering. According to the technical scheme, the problem that the current cloud API test efficiency is low is solved.

Description

Technical Field

[0001] This invention relates to the field of API automation technology, and in particular to a method and system that can automatically monitor and update content by combining API automation. Background Technology

[0002] In the context of intelligent and connected vehicles, providing users with rapidly iterating and continuously stable connected products has become a competitive arena in the new era. Currently, the testing efficiency of APIs relying on traditional single-point tools is gradually failing to meet the demands of high-quality agile iteration and release. There is a need to build an independent, controllable, cross-platform collaborative automated testing platform to manage API assets. In API automated testing, a tool capable of automatically monitoring and updating API content is indispensable.

[0003] Existing API automation tools primarily employ a JMeter + manual execution approach for API testing. This involves manually monitoring the execution of JMeter scripts and manually recording and summarizing the results in a table. However, this current JMeter + manual API testing method suffers from long execution times, low debugging efficiency, and the risk of quality issues arising from human error. Furthermore, current automation platforms are difficult to manage; when a large number of scripts are running, the platform slows down, is prone to crashing, and automation collaboration is not smooth. Summary of the Invention

[0004] The present invention aims to solve at least one of the technical problems existing in the prior art, and proposes a method and system that can automatically monitor and update content by combining API.

[0005] In a first aspect, embodiments of the present invention provide a method for automatically monitoring and updating content in conjunction with API automation, including:

[0006] Obtain the fixed Swagger access entry address for each microservice;

[0007] Monitor and update the content of existing Swagger APIs by triggering scheduled tasks or events.

[0008] In one embodiment, monitoring and synchronously updating the content of existing Swagger APIs via scheduled tasks or events includes:

[0009] In the API automated testing process, the Swagger JSON interface is used to query the results of each branch thread task. Through the task scheduling and execution settings, the results are crawled to the platform backend for data aggregation on a regular basis.

[0010] In one embodiment, monitoring and synchronously updating the content of existing Swagger APIs via scheduled tasks or events further includes:

[0011] After the data is aggregated, the interface information is compared, encapsulated, and then stored in the database.

[0012] In one embodiment, monitoring and synchronously updating the content of existing Swagger APIs via scheduled tasks or events further includes:

[0013] The interface information stored in the database will be compared with the data and presented on the front-end page.

[0014] In one embodiment, the step of monitoring and synchronously updating the content of the existing Swagger API via a scheduled task or event trigger further includes:

[0015] Add the URL to the Swagger JSON;

[0016] Make a request to the Swagger URL and retrieve the Swagger JSON;

[0017] Store the obtained Swagger JSON data;

[0018] Change detection for Swagger JSON data.

[0019] In one embodiment, storing the acquired Swagger JSON data includes:

[0020] Convert the data according to the format defined in the detailed design;

[0021] Data types are processed and converted according to the interface dimension, and then stored.

[0022] In one embodiment, the change identification of Swagger JSON data includes:

[0023] If no matching hash value is found for the interface, then the interface is a new interface.

[0024] If the hash value of the interface does not match the database, then the interface has been updated.

[0025] Secondly, embodiments of the present invention provide a system capable of automatically monitoring and updating content in conjunction with API automation, for configuring and implementing the above-described method, including:

[0026] The acquisition unit is used to obtain the fixed Swagger access entry address for each microservice;

[0027] The monitoring and synchronization update unit is used to monitor and synchronize the content of Swagger's existing API interfaces through scheduled tasks or events.

[0028] Thirdly, embodiments of the present invention provide an electronic device, including:

[0029] One or more processors;

[0030] Memory, used to store one or more programs;

[0031] When one or more programs are executed by one or more processors, the one or more processors implement any of the methods described above.

[0032] Fourthly, embodiments of the present invention provide a computer-readable medium storing a computer program, characterized in that the computer program, when executed by a processor, implements the steps of any of the methods described above.

[0033] This invention provides a method and system for automatically monitoring and updating content via API automation. First, it utilizes the fixed Swagger access entry address for each microservice. Then, it triggers scheduled tasks or events to monitor and synchronously update the content of existing Swagger API interfaces. This invention solves the problem of low efficiency in current cloud API testing. Attached Figure Description

[0034] The accompanying drawings, which are included to provide a further understanding of the invention and form part of this application, illustrate exemplary embodiments of the invention and, together with their description, serve to explain the invention and do not constitute an undue limitation thereof. In the drawings:

[0035] Figure 1 A flowchart illustrating a method for automatically monitoring and updating content in conjunction with API, provided by an embodiment of the present invention;

[0036] Figure 2 This is a technical principle diagram of a method for automatically monitoring and updating content via API, provided in an embodiment of the present invention, which involves periodically crawling Swagger JSON.

[0037] Figure 3 This invention provides a flowchart of an interface synchronization method for automatically monitoring and updating content via API.

[0038] Figure 4 This is a diagram of the front-end page in a method for automatically monitoring and updating content using APIs, provided in an embodiment of the present invention.

[0039] Figure 5A structural block diagram of a system that can automatically monitor and update content in conjunction with API, provided in an embodiment of the present invention;

[0040] Figure 6 This is a structural block diagram of an electronic device provided in an embodiment of the present invention. Detailed Implementation

[0041] To enable those skilled in the art to better understand the technical solutions of the present invention, exemplary embodiments of the present invention are described below in conjunction with the accompanying drawings, including various details of the embodiments of the present invention to aid understanding. These should be considered merely exemplary. Therefore, those skilled in the art should recognize that various changes and modifications can be made to the embodiments described herein without departing from the scope and spirit of the present invention. Similarly, for clarity and brevity, descriptions of well-known functions and structures are omitted in the following description.

[0042] Where there is no conflict, the various embodiments of the present invention and the features thereof may be combined with each other.

[0043] As used herein, the term “and / or” includes any and all combinations of one or more related enumerated entries.

[0044] The terminology used herein is for the purpose of describing particular embodiments only and is not intended to limit the invention. As used herein, the singular forms “a” and “the” are intended to include the plural forms as well, unless the context clearly indicates otherwise. It will also be understood that when the terms “comprising” and / or “made of” are used in this specification, the presence of the stated feature, integral, step, operation, element, and / or component is specified, but the presence or addition of one or more other features, integrals, steps, operations, elements, components, and / or groups thereof is not excluded. Terms such as “connected” or “linked” are not limited to physical or mechanical connections but can include electrical connections, whether direct or indirect.

[0045] Unless otherwise specified, all terms used herein (including technical and scientific terms) have the same meaning as commonly understood by one of ordinary skill in the art. It will also be understood that terms such as those defined in commonly used dictionaries should be interpreted as having the meaning consistent with their meaning in the context of the relevant art and the invention, and will not be interpreted as having an idealized or overly formal meaning unless expressly so defined herein.

[0046] In the technical solution of this invention, the collection, storage, use, processing, transmission, provision, and disclosure of user personal information all comply with relevant laws and regulations and do not violate public order and good morals. The use of user data in this technical solution follows relevant national laws and regulations (e.g., the "Information Security Technology - Personal Information Security Specification"). For example: appropriate measures are taken for personal information access control; restrictions are imposed on the display of personal information; the purpose of using personal information does not exceed the scope of direct or reasonable association; and explicit identity targeting is eliminated when using personal information to avoid precisely locating a specific individual.

[0047] In related technologies, existing API (Application Programming Interface) automation tools primarily employ a JMeter + manual execution approach for API testing. This involves manually monitoring the execution of JMeter scripts and manually recording and summarizing the results in a table. However, this current JMeter + manual API testing method suffers from long execution times, low debugging efficiency, and the risk of quality issues arising from human error. Furthermore, current automation platforms are difficult to manage, and when a large number of scripts are running, the platform slows down, is prone to crashing, and lacks smooth automation collaboration.

[0048] To address at least one of the technical problems existing in the aforementioned related technologies, this invention provides a method and system capable of automatically monitoring and updating content in conjunction with API automation. Wherein: Figure 1 A flowchart illustrating a method for automatically monitoring and updating content in conjunction with API, provided by an embodiment of the present invention; Figure 2 This is a technical principle diagram of a method for automatically monitoring and updating content via API, provided in an embodiment of the present invention, which involves periodically crawling Swagger JSON. Figure 3 This invention provides a flowchart of the interface synchronization steps in a method for automatically monitoring and updating content via API. Figure 4 This is a diagram of the front-end page in a method for automatically monitoring and updating content using APIs, provided in an embodiment of the present invention. Figure 5 A structural block diagram of a system that can automatically monitor and update content in conjunction with API, provided in an embodiment of the present invention; Figure 6 This is a structural block diagram of an electronic device provided in an embodiment of the present invention.

[0049] As an embodiment of the present invention, see Figure 1 This invention provides a method for automatically monitoring and updating content in conjunction with API automation, comprising:

[0050] Obtain the fixed Swagger access entry address for each microservice;

[0051] Monitor and update the content of existing Swagger APIs by triggering scheduled tasks or events.

[0052] The present invention provides a method for automatically monitoring and updating content via API automation. First, it utilizes the fixed Swagger access entry address of each microservice. Then, it uses scheduled tasks or events to trigger monitoring of existing Swagger API interfaces and synchronously update content. The technical solution of this invention addresses the problem of low efficiency in current cloud API testing.

[0053] See Figure 2 To optimize the above embodiments, the monitoring and synchronous updates of existing Swagger API interfaces triggered by scheduled tasks or events include:

[0054] In the API automated testing process, the Swagger JSON interface can be used to query the results of each branch thread task. By setting the task scheduling execution, the results can be crawled to the platform backend for data aggregation on a regular basis.

[0055] This includes monitoring and synchronously updating the interfaces of existing Swagger APIs via scheduled tasks or events, which also includes:

[0056] After the data is aggregated, the interface information is compared, encapsulated, and then stored in the database.

[0057] Once the interface information comparison and encapsulation is passed to the database, the interface information comparison data stored in the database can be presented on the front-end page.

[0058] In this embodiment, the above processing method is adopted. After the interface information is obtained from the Swagger JSON interface of each microservice, it is compared and encapsulated on the platform backend. This process does not modify the existing microservices, thus minimizing the impact on each microservice and avoiding quality problems caused by human error. In addition, the interface information can be reorganized, modified, and saved as needed, and the interface information processing has a high degree of flexibility.

[0059] See Figure 3 To further optimize the above embodiments, the following steps are adopted when synchronously updating the acquired interface information:

[0060] Adding a URL to the Swagger JSON allows you to obtain the API endpoints, thus forming the interface paths that can be requested.

[0061] Based on the interface path formed by the added URL, a request is made to the Swagger URL of each microservice to obtain the Swagger JSON. In the preferred embodiment, this request is executed as a scheduled task, so that the interface information of each microservice can be obtained periodically to form a scheduled update of the interface information. In another approach, the interface information of the microservice can be obtained by event triggering, so that the interface information changed due to events can be obtained in a timely manner.

[0062] Store the obtained Swagger JSON data;

[0063] Furthermore, when storing data, it is also necessary to identify changes in Swagger JSON data.

[0064] Specifically, storing the obtained Swagger JSON data includes:

[0065] The conversion format is designed and defined in detail in advance. When each microservice obtains the interface information, the interface information is converted according to the pre-defined format. Specifically, the data types are processed and converted according to the interface dimension and stored in the database, thereby ensuring the consistency of the stored data.

[0066] In this embodiment of the invention, when storing interface information in the database, each interface information is matched with a hash value to facilitate subsequent lookup or retrieval. Based on this, when identifying changes to Swagger JSON data, the following two methods can be used for identification and modification:

[0067] If no matching hash value is found in the obtained interface information, it indicates that the interface corresponding to the interface information is a new interface. Therefore, it is identified as a newly added interface, and the interface information can be stored in the database after matching the hash value.

[0068] If the obtained interface information matches a hash value, but when compared with the hash value in the database, the two do not match, then the interface information corresponding to that interface in the database can be updated.

[0069] Secondly, based on the same inventive concept, embodiments of the present invention provide a system capable of automatically monitoring and updating content in conjunction with API automation, configured to implement the above-described method, see [link to documentation]. Figure 5 ,include:

[0070] The acquisition unit is used to access the entry address via the fixed Swagger address of each microservice;

[0071] The monitoring and synchronization update unit is used to monitor and synchronize the content of Swagger's existing API interfaces through scheduled tasks or events.

[0072] In this embodiment, the acquisition unit first obtains the fixed Swagger access entry address of each microservice, and the monitoring and synchronization update unit can trigger interface monitoring of the existing Swagger API through the Swagger access entry address via scheduled tasks or events, and update the interface information of the system based on the monitored interface information.

[0073] The monitoring and synchronization update unit includes multiple modules, such as the platform backend, database, and display module.

[0074] The platform backend can obtain the interface information of each microservice by acquiring the unit based on scheduled tasks or events, and process the interface information, such as comparison and encapsulation.

[0075] The database serves as a storage module; the platform backend stores the compared and encapsulated interface information in the database.

[0076] When storing interface information, the conversion format is designed and defined in detail in advance. When each microservice obtains the interface information, it converts the interface information according to the pre-defined format. Specifically, the data types are processed and converted according to the interface dimension, and the converted data information is stored in the database.

[0077] On the other hand, during storage, it is also necessary to identify changes to the stored data. Specifically, if the obtained interface information does not have a matching hash value, it indicates that the interface corresponding to the interface information is a new interface, and it is identified as a newly added interface. The interface information can be stored in the database after matching the hash value. If the obtained interface information has a matching hash value, but the two do not match when compared with the hash value in the database, the interface information corresponding to that interface in the database can be updated.

[0078] See Figure 4 The display module, on the other hand, can retrieve interface information from the database for display. Specifically, the display module can present information on the front-end page using a webpage format.

[0079] Based on this, the system provided in this embodiment of the invention, based on a fixed Swagger access entry address for each microservice, not only avoids the impact of the API automated testing process on each microservice and completely avoids quality risks caused by human error in the current API, but also greatly improves API testing efficiency by being triggered by scheduled tasks or events. Furthermore, the system provided in this embodiment of the invention automatically stores all acquired interface information in a database, facilitating its management.

[0080] Based on the same inventive concept, embodiments of the present invention also provide an electronic device. Figure 6 This is a structural block diagram of an electronic device provided in an embodiment of the present invention. Figure 6 As shown, an embodiment of the present invention provides an electronic device including: one or more processors 101, a memory 102, and one or more I / O interfaces 103. The memory 102 stores one or more programs, which, when executed by the one or more processors, enable the one or more processors to implement any of the methods described in the above embodiments that can automatically monitor and update content in conjunction with APIs; the one or more I / O interfaces 103 are connected between the processor and the memory, configured to enable information interaction between the processor and the memory.

[0081] The processor 101 is a device with data processing capabilities, including but not limited to a central processing unit (CPU); the memory 102 is a device with data storage capabilities, including but not limited to random access memory (RAM, more specifically SDRAM, DDR, etc.), read-only memory (ROM), electrically erasable programmable read-only memory (EEPROM), and flash memory (FLASH); the I / O interface (read / write interface) 103 is connected between the processor 101 and the memory 102, and can realize information interaction between the processor 101 and the memory 102, including but not limited to a data bus (Bus).

[0082] In some embodiments, the processor 101, memory 102, and I / O interface 103 are interconnected via bus 104, and thus connected to other components of the computing device.

[0083] In some embodiments, the one or more processors 101 include a field-programmable gate array.

[0084] This invention also provides a computer-readable medium. The computer-readable medium stores a computer program, wherein when executed by a processor, the program implements the steps of any of the methods described above that can automatically monitor and update content in conjunction with an API. The computer-readable storage medium can be volatile or non-volatile.

[0085] This invention also provides a computer program product, including computer-readable code, or a non-volatile computer-readable storage medium carrying computer-readable code. When the computer-readable code is run in the processor of an electronic device, the processor in the electronic device executes the above-described method that can automatically monitor and update content in conjunction with API automation.

[0086] Those skilled in the art will understand that all or some of the steps, systems, and apparatuses disclosed above, and their functional modules / units, can be implemented as software, firmware, hardware, or suitable combinations thereof. In hardware implementations, the division between functional modules / units mentioned above does not necessarily correspond to the division of physical components; for example, a physical component may have multiple functions, or a function or step may be performed collaboratively by several physical components. Some or all physical components may be implemented as software executed by a processor, such as a central processing unit, digital signal processor, or microprocessor, or as hardware, or as an integrated circuit, such as an application-specific integrated circuit (ASIC). Such software can be distributed on a computer-readable storage medium, which may include computer storage media (or non-transitory media) and communication media (or transient media).

[0087] As is known to those skilled in the art, the term computer storage medium includes volatile and non-volatile, removable and non-removable media implemented in any method or technology for storing information, such as computer-readable program instructions, data structures, program modules, or other data. Computer storage media includes, but is not limited to, random access memory (RAM), read-only memory (ROM), erasable programmable read-only memory (EPROM), static random access memory (SRAM), flash memory or other memory technologies, portable compact disc read-only memory (CD-ROM), digital versatile disc (DVD) or other optical disc storage, magnetic cartridges, magnetic tape, disk storage or other magnetic storage devices, or any other medium that can be used to store desired information and is accessible to a computer. Furthermore, it is known to those skilled in the art that communication media typically contain computer-readable program instructions, data structures, program modules, or other data in modulated data signals such as carrier waves or other transmission mechanisms, and may include any information delivery medium.

[0088] The computer-readable program instructions described herein can be downloaded from computer-readable storage media to various computing / processing devices, or downloaded via a network, such as the Internet, local area network, wide area network, and / or wireless network, to an external computer or external storage device. The network may include copper transmission cables, fiber optic transmission, wireless transmission, routers, firewalls, switches, gateway computers, and / or edge servers. A network adapter card or network interface in each computing / processing device receives the computer-readable program instructions from the network and forwards them to the computer-readable storage media in the respective computing / processing device.

[0089] The computer program instructions used to perform the operations of this invention may be assembly instructions, instruction set architecture (ISA) instructions, machine instructions, machine-dependent instructions, microcode, firmware instructions, state setting data, or source code or object code written in any combination of one or more programming languages, including object-oriented programming languages ​​such as Smalltalk, C++, etc., and conventional procedural programming languages ​​such as the "C" language or similar programming languages. The computer-readable program instructions may be executed entirely on the user's computer, partially on the user's computer, as a standalone software package, partially on the user's computer and partially on a remote computer, or entirely on a remote computer or server. In cases involving a remote computer, the remote computer may be connected to the user's computer via any type of network—including a local area network (LAN) or a wide area network (WAN)—or may be connected to an external computer (e.g., via the Internet using an Internet service provider). In some embodiments, electronic circuitry, such as programmable logic circuitry, field-programmable gate arrays (FPGAs), or programmable logic arrays (PLAs), is personalized by utilizing state information from the computer-readable program instructions. This electronic circuitry can execute the computer-readable program instructions to implement various aspects of the invention.

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

[0091] Various aspects of the present invention are described herein with reference to flowchart illustrations and / or block diagrams of methods, apparatus (systems), and computer program products according to embodiments of the invention. It should be understood that each block of the flowchart illustrations and / or block diagrams, and combinations of blocks in the flowchart illustrations and / or block diagrams, can be implemented by computer-readable program instructions.

[0092] These computer-readable program instructions can be provided to a processor of a general-purpose computer, a special-purpose computer, or other programmable data processing apparatus to produce a machine such that, when executed by the processor of the computer or other programmable data processing apparatus, they create means for implementing the functions / actions specified in one or more blocks of the flowchart and / or block diagram. These computer-readable program instructions can also be stored in a computer-readable storage medium that causes a computer, programmable data processing apparatus, and / or other device to operate in a particular manner; thus, the computer-readable medium storing the instructions comprises an article of manufacture that includes instructions for implementing aspects of the functions / actions specified in one or more blocks of the flowchart and / or block diagram.

[0093] Computer-readable program instructions may also be loaded onto a computer, other programmable data processing apparatus, or other device to cause a series of operational steps to be performed on the computer, other programmable data processing apparatus, or other device to produce a computer-implemented process, thereby causing the instructions executed on the computer, other programmable data processing apparatus, or other device to perform the functions / actions specified in one or more boxes of a flowchart and / or block diagram.

[0094] The flowcharts and block diagrams in the accompanying drawings illustrate the architecture, functionality, and operation of possible implementations of systems, methods, and computer program products according to various embodiments of the present invention. In this regard, each block in a flowchart or block diagram may represent a module, segment, or portion of an instruction, which contains one or more executable instructions for implementing a specified logical function. In some alternative implementations, the functions marked in the blocks may occur in a different order than those shown in the drawings. For example, two consecutive blocks may actually be executed substantially in parallel, and they may sometimes be executed in reverse order, depending on the functions involved. It should also be noted that each block in the block diagrams and / or flowcharts, and combinations of blocks in the block diagrams and / or flowcharts, may be implemented using a dedicated hardware-based system that performs the specified function or action, or using a combination of dedicated hardware and computer instructions.

[0095] Example embodiments have been disclosed herein, and while specific terminology has been used, it is for illustrative purposes only and should be construed as such, and is not intended to be limiting. In some instances, it will be apparent to those skilled in the art that features, characteristics, and / or elements described in conjunction with particular embodiments may be used alone, or in combination with features, characteristics, and / or elements described in conjunction with other embodiments, unless otherwise expressly indicated. Therefore, those skilled in the art will understand that various changes in form and detail may be made without departing from the scope of the invention as set forth in the appended claims.

Claims

1. A method for automatically monitoring and updating content in conjunction with API, characterized in that, include: Obtain the fixed Swagger access entry address for each microservice; Monitor and update the content of existing Swagger APIs by triggering scheduled tasks or events.

2. The method according to claim 1, characterized in that, The monitoring and synchronous updates of existing Swagger API interfaces triggered by scheduled tasks or events include: In the API automated testing process, the Swagger JSON interface is used to query the results of each branch thread task. Through the task scheduling and execution settings, the results are crawled to the platform backend for data aggregation on a regular basis.

3. The method according to claim 2, characterized in that, The method of monitoring and synchronously updating the content of existing Swagger APIs through scheduled tasks or events also includes: After the data is aggregated, the interface information is compared, encapsulated, and then stored in the database.

4. The method according to claim 3, characterized in that, The method of monitoring and synchronously updating the content of existing Swagger APIs through scheduled tasks or events also includes: The interface information stored in the database will be compared with the data and presented on the front-end page.

5. The method according to claim 1, characterized in that, The method of monitoring and synchronously updating the content of existing Swagger APIs through scheduled tasks or events also includes: Add the URL to the Swagger JSON; Make a request to the Swagger URL and retrieve the Swagger JSON; Store the obtained Swagger JSON data; Change detection for Swagger JSON data.

6. The method according to claim 5, characterized in that, The storage of the obtained Swagger JSON data includes: Convert the data according to the format defined in the detailed design; Data types are processed and converted according to the interface dimension, and then stored.

7. The method according to claim 5, characterized in that, The change identification of Swagger JSON data includes: If no matching hash value is found for the interface, then the interface is a new interface. If the hash value of the interface does not match the database, then the interface has been updated.

8. A system capable of automatically monitoring and updating content in conjunction with API, characterized in that, For configuring the implementation of the method according to any one of claims 1-7, comprising: The acquisition unit is used to obtain the fixed Swagger access entry address for each microservice; The monitoring and synchronization update unit is used to monitor and synchronize the content of Swagger's existing API interfaces through scheduled tasks or events.

9. An electronic device, characterized in that, include: One or more processors; Memory, used to store one or more programs; When the one or more programs are executed by the one or more processors, the one or more processors implement the method as described in any one of claims 1 to 7.

10. A computer-readable medium having a computer program stored thereon, characterized in that, When the computer program is executed by a processor, it implements the steps of the method as described in any one of claims 1 to 7.

Images