CN115220992A - Interface change monitoring method and device, computer equipment and storage medium - Google Patents

Abstract

The invention relates to an interface change monitoring method, an interface change monitoring device, computer equipment and a storage medium, wherein the method comprises the following steps: monitoring the service state of the service module according to a preset monitoring period; according to the service state triggering interface calling instruction, calling a target interface to obtain return data of the target interface; and determining whether the return data of the target interface is consistent with interface data prestored in a database so as to monitor the change event of the target interface, wherein the prestored interface data is determined based on the historical return data of the target interface. The method reduces the interface operation and maintenance management cost, improves the service operation efficiency, and ensures the data accuracy and quality of the interface data acquisition link.

Description

Interface change monitoring method, device, computer equipment and storage medium

technical field

The present invention relates to the field of computer technology, and in particular, to an interface change monitoring method, device, computer equipment and storage medium.

Background technique

The current common interface data collection is usually based on manual data entry. For example, Baidu, Ali, JD.com and other major products are mainly processed manually. There are few cases of automatic processing, which can support unlimited Cases where data standards are collected are extremely rare.

In many enterprise interface gateway products, the collection of interface information is an indispensable link. From the initial creation, modification to disposal of the interface, the maintenance work involving interface information is carried out by manual operation, which consumes a lot of time. manpower and time costs.

Relying on manual interface data maintenance is not only labor-intensive and cost-intensive, but also has poor timeliness in multiple links. When the interface is increased, decreased or changed, it cannot be synchronized to the interface information collector or interface user in time, which is easy to cause delay.

The traditional method of manually collecting interface data cannot guarantee the accuracy of the data, which may cause some input errors, resulting in the emergence of new problems or rework.

For interface information collection products designed and developed using the adapter mode, it will undoubtedly greatly limit the technical standards adopted by the interface provider, and cannot adapt to new data formats or data standards. The usual solution is to carry out secondary development. Add new capabilities to make up for design deficiencies and deficiencies.

SUMMARY OF THE INVENTION

The present application provides an interface change monitoring method, apparatus, computer equipment and storage medium.

A first aspect provides an interface change monitoring method, the method comprising:

Monitor the service status of the service module according to the preset monitoring period;

Trigger the interface calling instruction according to the service state, call the target interface, and obtain the return data of the target interface;

It is determined whether the return data of the target interface is consistent with the interface data pre-stored in the database, so as to monitor the change event of the target interface, wherein the pre-stored interface data is determined based on the historical return data of the target interface.

In some embodiments, the triggering an interface invocation instruction according to the service state includes:

When a state change occurs in the service state of the service module, an interface calling instruction is triggered.

In some embodiments, the calling target interface to obtain return data of the target interface, including:

The service module returns return data in a JSON data structure, and the return data includes description information of the target interface.

In some embodiments, the pre-stored interface data is determined based on historical return data of the target interface, including:

The target interface is called at least twice, and if the historical return data returned after each call is the same, the historical return data is stored.

In some embodiments, the return data includes one or a combination of a data structure of the target interface, an extraction path, and interface parameters;

The determining whether the returned data of the target interface is consistent with the interface data pre-stored in the database includes one or a combination of the following:

Determine whether the data structure of the returned data is consistent with the pre-stored data structure;

Determine whether the extraction path of the returned data is consistent with the pre-stored extraction path;

Determine whether the interface parameters of the returned data are consistent with the pre-stored interface parameters.

In some embodiments, the data structure of the returned data of the interface is obtained by the following steps:

Perform lexical analysis on the returned data using an abstract syntax tree to obtain a data structure of the returned data.

In some embodiments, the method further includes:

Receive basic information of the service module that is run for the first time.

In the interface change monitoring method, device, computer equipment and storage medium provided by this application, the interface change monitoring method triggers an interface call instruction according to the service state, calls the target interface, and obtains the return data of the target interface; determines the return data and the pre-stored data in the database. Whether the data is consistent to monitor the change event of the target interface. Therefore, the present application adopts the discovery mechanism to trigger and automatically complete the collection and change of interface information and other synchronization tasks to provide timely and accurate data sources for downstream products. It reduces the operation and maintenance management cost of the service module and improves the efficiency of business operation.

Description of drawings

1 is a flowchart of an interface change monitoring method provided in one embodiment;

Fig. 2 is another flowchart of the interface change monitoring method provided in one embodiment;

3 is a block diagram of an interface change monitoring device provided in one embodiment;

Figure 4 is a block diagram of a computer device in one embodiment.

Detailed ways

In order to make the objectives, technical solutions and advantages of the present invention clearer, the present invention will be further described in detail below with reference to the accompanying drawings and embodiments. It should be understood that the specific embodiments described herein are only used to explain the present invention, but not to limit the present invention.

It will be understood that the terms "first", "second", etc. used in this application may be used herein to describe various elements, but these elements are not limited by these terms. These terms are only used to distinguish a first element from another element.

Application programming interface (Application Programming Interface, interface) can realize mutual communication and data sharing between computer software and different platforms. Developers will make changes to the interface according to actual needs. In addition, bugs in the development program will also cause unexpected changes to the interface. The change of the interface refers to the change of the underlying data of the interface, including the addition and deletion of interface fields, the change of the field type and content, and the switch between the available state and the unavailable state of the interface. With the popularity of microservices, it is particularly important to perceive the changes of the interface in time after development and release. If the interface changes are not discovered in time due to problems in development, or the back-end developers make changes to the interfaces, the front-end development If the personnel fails to obtain the interface change information in time, it may lead to the collapse of the entire application system. In related technologies, developers are mainly responsible for maintaining interface documents. However, it is often difficult for developers to maintain a large number of interface documents independently and efficiently. By manpower maintaining interface documents to perceive interface changes, problems cannot be found in a timely and efficient manner, which in turn makes it difficult to deal with problems. There is lag. In this regard, in order to solve the hysteresis problem of manual maintenance perception of interface changes, the present application provides an interface change monitoring method, which can automatically monitor interface change events.

As shown in Figures 1 and 2, in some embodiments, an interface change monitoring method is provided, which may include:

Step 101, monitor the service status of the service module according to a preset monitoring period;

Among them, the intensity of service status monitoring of the service module can be set according to actual needs. For example, by setting a timer, when the time set by the timer is reached, a monitoring instruction is sent to the service status of the service module.

In some embodiments, as shown in FIG. 2 , a plurality of business service modules are configured on the service module operating platform, and these business service modules can provide different functions, such as a login service module on the WeChat platform, a voice chat service module, etc. . The service module operating platform is also configured with a service registration module, an automatic discovery module, a mapping relationship configuration module, an API data collection module, a JSON data conversion module, a data update/API information storage module, and a service management module.

Service registration module: As the service registration center, it provides registration API for the service module to call. After each service module is deployed and the basic service of the service module is changed, it will send a registration request to the registration center at the first time, and record the service name of the service module, Identification information, running status and other information. During the running phase, the service module regularly reports information such as its own survival status or running status to the registration center by means of a heartbeat mechanism.

Automatic discovery module: The automatic discovery module has two functions. The automatic discovery module has two functions. First, through the polling mechanism, it regularly sends a retrieval request to the service registration module to query the list of available services, and the service management module receives service information. Second, when the service state is switched to the running state, interface query and comparison operations are triggered to determine whether an interface update event occurs. If there is an interface update, a new round of interface information collection tasks will be triggered.

Mapping relationship configuration module: The mapping relationship here mainly refers to the path used to extract the specified data from the json text information during the json data conversion process, usually jsonpath. The main function of this module is to provide dependable configuration data for the parsing of any json file by simply configuring the path in the configuration interface during the normal operation of the service module, realizing the transition from hard coding to configuration or data. a technological shift. The returned data format is different, re-develop the function module, upgrade or modify it.

API data collection module: When the automatic discovery module finds a new service or the API list of a service changes, it will trigger the current module to work. The main function of this module is to obtain the service address according to the service registration information, and obtain all the API information under the service at one time according to the API information query interface provided by the service, and hand it over to the automatic discovery module and the JSON data conversion module for processing. The automatic discovery module will compare the received latest API information with the API information of the previous version to check whether there is an update. If there is an update, it will be directly handed over to the JSON data conversion module for processing.

JSON data conversion module: This module is a task execution module, which is mainly used to complete the conversion of the original JSON format data to the storage data model. In the conversion process, important parameters for extracting data are involved: the extraction path (jsonpath), and the target data structure ( targetObject) or field (targetFiled), should be obtained from the mapping relationship configuration module.

Data update/API information storage module: This module belongs to the post operation and is the last execution stage, which is used to persist or update the converted target data to our storage device, usually a database.

Service management module: It is a pure management module, which provides two types of data: service status and service configuration. Service status is used to record the running status of each service module; service configuration is used to save and manage jsonpath configuration information, which is used for subsequent conversion work. Dynamically configured data.

In some embodiments, the above step 101 may include:

When the service state of the service module changes, the interface calling instruction is triggered.

The state change includes a first state change and a second state change, and the first state change includes that the service state of the service module is a stopped state in the previous monitoring period, and the service state of the service module is a running state in the current monitoring period; the second state change includes: The status change includes that the service module is a newly added service module, and the newly added service module is in a running state.

Step 102: Trigger the interface calling instruction according to the service status, call the target interface, and obtain the return data of the target interface;

It can be understood that the target API will send return data in response to the calling instruction, and the return data can reflect the underlying data of the target API. When the target API changes, the return data will also change accordingly. Therefore, by analyzing the return data of the target API, it is possible to monitor whether the API has changed.

In some embodiments, the service module returns return data in a JSON data structure, and the return data includes description information of the target interface. In order to cooperate with the automatic discovery of API, each service module must provide an accessible API for returning information in json format. The API information here refers to the description information or metadata information of the API.

Among them, the JSON (JavaScript Object Notation) data structure is a lightweight data exchange format, which is a subset based on javascript. It completely adopts the text format of independent language, which is easy to read and write, and easy to parse and generate by machine. It is very suitable for for server-client interaction.

This application adopts the method of "dynamic configuration + Jsonpath analysis", which greatly expands the universal applicability of automated API data collection, breaks the conventional technical barrier that requires secondary coding to be expanded, and enables the automatic API collection function The landing and application become inevitable. The collection of API information in different json formats can be completed in one development, reducing possible secondary development and expansion.

Step 103: Determine whether the return data of the target interface is consistent with the interface data pre-stored in the database, so as to monitor the change event of the target interface, wherein the pre-stored interface data is determined based on the historical return data of the target interface.

In some embodiments, the pre-stored interface data in step 103 is determined based on historical return data of the target interface, and may include:

The target interface is called at least twice, and if the historical return data returned after each call is the same, the historical return data is stored.

In some embodiments, the return data includes one or a combination of a data structure of the target interface, an extraction path, and interface parameters;

Determine whether the returned data of the target interface is consistent with the interface data pre-stored in the database, including one or a combination of the following:

Determine whether the data structure of the returned data is consistent with the pre-stored data structure;

Determine whether the extraction path of the returned data is consistent with the pre-stored extraction path;

Determine whether the interface parameters of the returned data are consistent with the pre-stored interface parameters.

Among them, when the target API changes, the data structure of the returned data also changes accordingly, and when the target API does not change, the data structure of the returned data for each call is consistent. Therefore, by comparing whether the data structure of the returned data is consistent with the pre-stored data structure, the change events of the target API can be monitored, and the API documents can be maintained without manual intervention, realizing the automatic monitoring of API changes.

In some embodiments, the data structure of the returned data of the interface is obtained by the following steps:

Use the abstract syntax tree to perform lexical analysis on the returned data to obtain the data structure of the returned data.

The application adopts the automatic discovery and collection mechanism to realize the unified collection of interface information, and has made great positive improvements in terms of data accuracy, business efficiency, and operation and maintenance management costs. Especially for some business systems with many business services, a large number of APIs, and continuous updates and iterations, the management and maintenance of APIs must be a complex and huge workload. In particular, the input of basic API information is extremely inefficient.

At the same time, automatic discovery of interface changes, as an integration capability, can be integrated with other business products to form some product ecosystems. For example: API gateway management platform, automated API testing platform, interface life cycle management system, etc. All products that use API as the basic resource will gain great product integration advantages from now on.

In some embodiments, as shown in FIG. 3, an interface change monitoring device is provided, including:

a state monitoring unit 311, configured to monitor the service state of the service module according to a preset monitoring period;

The interface data collection unit 312 is used to trigger the interface calling instruction according to the service state, call the target interface, and obtain the return data of the target interface;

The change determination unit 313 is configured to determine whether the return data of the target interface is consistent with the interface data pre-stored in the database, so as to monitor the change event of the target interface, wherein the pre-stored interface data is determined based on the historical return data of the target interface.

This application uses the discovery mechanism to trigger and automate the collection and change of API information to provide timely and accurate data sources for downstream products. It adopts advanced data analysis technology, supports dynamic configuration of data in the data analysis process, and supports data extraction of API information in any json format. It is not limited to the extraction of API information, and can be applied to other data conversion and extraction scenarios; The capabilities can be extended with simple configuration, and subsequent coding by developers is not required.

In one embodiment, as shown in FIG. 4, a computer device is presented, the computer device including a processor, a non-volatile storage medium, a memory and a network interface connected by a system bus. The non-volatile storage medium of the computer device stores an operating system, a knowledge base, and computer-readable instructions, and the knowledge base may store a sequence of control information. When the computer-readable instructions are executed by the processor, the Implement a short media tag extraction method. The processor of the computer device is used to provide computing and control capabilities and support the operation of the entire computer device. Computer-readable instructions may be stored in the memory of the computer device, and when executed by the processor, the computer-readable instructions may cause the processor to execute a method for extracting short media tags. The network interface of the computer equipment is used for communication with the terminal connection. Those skilled in the art can understand that the structure shown in FIG. 4 is only a block diagram of a partial structure related to the solution of the present application, and does not constitute a limitation on the computer equipment to which the solution of the present application is applied. Include more or fewer components than shown in the figures, or combine certain components, or have a different arrangement of components.

When the processor executes the computer program, the following steps are implemented: monitor the service status of the service module according to a preset monitoring period; trigger an interface calling instruction according to the service status, call the target interface, and obtain the return data of the target interface; determine the return data of the target interface and Check whether the pre-stored interface data in the database are consistent, so as to monitor the change event of the target interface, wherein the pre-stored interface data is determined based on the historical return data of the target interface.

In one embodiment, a storage medium storing computer-readable instructions is provided. When executed by one or more processors, the computer-readable instructions cause the one or more processors to perform the following steps: according to a preset Monitoring cycle, monitoring the service status of the service module; triggering the interface calling instruction according to the service status, calling the target interface, and obtaining the return data of the target interface; Change event, wherein the pre-stored interface data is determined based on the historical return data of the target interface.

Those of ordinary skill in the art can understand that the realization of all or part of the processes in the methods of the above embodiments can be accomplished by instructing the relevant hardware through a computer program, and the computer program can be stored in a computer-readable storage medium, and the program is During execution, it may include the processes of the embodiments of the above-mentioned methods. The aforementioned storage medium may be a non-volatile storage medium such as a magnetic disk, an optical disk, a read-only memory (Read-Only Memory, ROM), or a random access memory (Random Access Memory, RAM).

The technical features of the above embodiments can be combined arbitrarily. For the sake of brevity, all possible combinations of the technical features in the above embodiments are not described. However, as long as there is no contradiction in the combination of these technical features, all It is considered to be the range described in this specification.

The above-mentioned embodiments only represent several embodiments of the present invention, and the descriptions thereof are specific and detailed, but should not be construed as a limitation on the scope of the patent of the present invention. It should be pointed out that for those of ordinary skill in the art, without departing from the concept of the present invention, several modifications and improvements can also be made, which all belong to the protection scope of the present invention. Therefore, the protection scope of the patent of the present invention shall be subject to the appended claims.

Claims (10)

1. an interface change monitoring method, is characterized in that, comprises: Monitor the service status of the service module according to the preset monitoring period; Trigger the interface calling instruction according to the service state, call the target interface, and obtain the return data of the target interface; It is determined whether the return data of the target interface is consistent with the interface data pre-stored in the database, so as to monitor the change event of the target interface, wherein the pre-stored interface data is determined based on the historical return data of the target interface. 2. The interface change monitoring method according to claim 1, wherein the triggering an interface calling instruction according to the service state comprises: When a state change occurs in the service state of the service module, an interface calling instruction is triggered. 3. The interface change monitoring method according to claim 1, wherein the calling target interface obtains the return data of the target interface, comprising: The service module returns return data in a JSON data structure, and the return data includes description information of the target interface. 4. The interface change monitoring method according to claim 1, wherein the pre-stored interface data is determined based on historical return data of the target interface, comprising: The target interface is called at least twice, and if the historical return data returned after each call is the same, the historical return data is stored. 5. The interface change monitoring method according to claim 1, wherein the returned data comprises one or a combination of a data structure, an extraction path and an interface parameter of the target interface; The determining whether the returned data of the target interface is consistent with the interface data pre-stored in the database includes one or a combination of the following: Determine whether the data structure of the returned data is consistent with the pre-stored data structure; Determine whether the extraction path of the returned data is consistent with the pre-stored extraction path; Determine whether the interface parameters of the returned data are consistent with the pre-stored interface parameters. 6. The interface change monitoring method according to claim 5, wherein the data structure of the returned data of the interface is obtained by the following steps: Perform lexical analysis on the returned data using an abstract syntax tree to obtain a data structure of the returned data. 7. The interface change monitoring method according to claim 1, wherein the method further comprises: Receive basic information of the service module that is run for the first time. 8. An interface change monitoring device, characterized in that, comprising: a state monitoring unit, used for monitoring the service state of the service module according to a preset monitoring period; an interface data collection unit, configured to trigger an interface calling instruction according to the service state, call a target interface, and obtain return data of the target interface; A change determination unit, configured to determine whether the returned data of the target interface is consistent with the interface data pre-stored in the database, so as to monitor the change event of the target interface, wherein the pre-stored interface data is returned based on the history of the target interface Data OK. 9. A computer device comprising a memory and a processor, wherein computer-readable instructions are stored in the memory, and when the computer-readable instructions are executed by the processor, the processor is caused to perform as claimed in claims 1 to 7 The steps of the interface change monitoring method described in any one of claims. 10. A storage medium storing computer-readable instructions that, when executed by one or more processors, cause the one or more processors to perform any one of claims 1 to 7 The steps of the interface change monitoring method.

Images