Method, device, equipment and medium for managing API based on tree structure classification

Abstract

The present application relates to the technical field of computer software development, and in particular to a method, apparatus, device and medium for managing APIs based on tree-structured classification, wherein the method comprises: determining the current root node and the classification information corresponding to the current root node; based on the classification information, determining the multiple child nodes of the current root node, and obtaining the application programming interface API information of each of the multiple child nodes; based on a preset flattening processing method, obtaining the classification information of the tree structure according to the current root node, the classification information, the multiple child nodes of the current root node and the API information of each of the multiple child nodes, and filling the classification information of the tree structure into a tree list, and displaying the filled-in tree list. Thus, the problem that with the increase in APIs and the continuous increase in management costs, it is difficult for related technologies to quickly understand the structure and composition of the API of the entire application is solved, and large-scale single-body applications or microservice applications can be classified and managed.

Description

Technical Field

[0001] The present application relates to the technical field of computer software development, and in particular to a method, apparatus, device and medium for managing an API (Application Programming Interface) based on a tree structure classification. Background Art

[0002] With the development of computer software technology, there are more and more APIs in web applications, and the management costs are also increasing. It is difficult to quickly understand the structure and composition of the entire application API.

[0003] In the related art, an open API management method, device, system and computer-readable storage medium are designed to automatically obtain open API information and perform API management for business personnel. Another application program interface API management method and device are designed to manage API input and output parameters to facilitate callers to obtain information.

[0004] However, the related technology does not classify and manage the APIs of the entire project. Summary of the Invention

[0005] The present application provides a method, device, vehicle and storage medium for classifying and managing APIs based on a tree structure to solve the problem that as the number of APIs increases, management costs continue to rise, and related technologies are difficult to quickly understand the structure and composition of the API of the entire application. It is suitable for classified management of large-scale single applications or microservice applications.

[0006] The first aspect of the present application provides a method for managing APIs based on tree-structured classification, comprising the following steps: determining a current root node and classification information corresponding to the current root node; based on the classification information, determining multiple child nodes of the current root node, and obtaining application programming interface API information of each child node of the multiple child nodes; and based on a preset flattening processing method, obtaining classification information of a tree structure according to the current root node, the classification information, multiple child nodes of the current root node, and API information of each child node of the multiple child nodes, and filling the classification information of the tree structure into a tree list, and displaying the filled-in tree list.

[0007] Based on the above technical means, this application can solve the problem that as the number of APIs increases, management costs continue to rise, and related technologies are difficult to quickly understand the structure and composition of the API of the entire application. It is suitable for classified management of large-scale single applications or microservice applications.

[0008] Optionally, in some embodiments, the preset flattening processing method obtains classification information of a tree structure according to the current root node, the classification information, the multiple child nodes of the current root node, and the API information of each child node of the multiple child nodes, including: arranging the current root node, the classification information, the multiple child nodes of the current root node, and the API information of each child node of the multiple child nodes in reverse order according to the target field, and if the target fields are the same, sorting them in the dictionary order of the preset classification path to obtain the classification information of the tree structure; wherein, when the multiple child nodes of the current root node are stored in the preset database, the automatically generated database primary key is assigned to the target field, and when the sub-category corresponding to each child node is stored in the preset database, it is the same as the target field corresponding to each child node.

[0009] Based on the above technical means, this application can manage the API through the API path, present the API structure and composition of large-scale applications, and facilitate management by relevant personnel.

[0010] Optionally, in some embodiments, the API information includes at least one of API creator, API creation time, API launch time, API name, API running status, API path, input parameter data, and output parameter data.

[0011] Based on the above technical means, this application can be applied to large-scale single-unit applications or microservice applications for easy management.

[0012] Optionally, in some embodiments, the classification information includes at least one of a classification name, a classification description, a parent classification path, and a child classification path.

[0013] Based on the above technical means, this application can be used by developers during the development process to facilitate management.

[0014] The second aspect of the present application provides an apparatus for classifying and managing an API based on a tree structure, comprising: a determination module for determining a current root node and classification information corresponding to the current root node; an acquisition module for determining, based on the classification information, multiple child nodes of the current root node, and obtaining application programming interface API information of each child node of the multiple child nodes; and a classification module for obtaining, based on a preset flattening processing method, classification information of a tree structure according to the current root node, the classification information, multiple child nodes of the current root node, and API information of each child node of the multiple child nodes, and filling the classification information of the tree structure into a tree list, and displaying the filled-in tree list.

[0015] Optionally, in some embodiments, the classification module is specifically used to: arrange the current root node, the classification information, the multiple child nodes of the current root node, and the API information of each child node of the multiple child nodes in reverse order according to the target field; if the target fields are the same, sort them according to the dictionary order of the preset classification path to obtain the classification information of the tree structure; wherein, when the multiple child nodes of the current root node are stored in the preset database, the automatically generated database primary key is assigned to the target field, and when the sub-category corresponding to each child node is stored in the preset database, it is the same as the target field corresponding to each child node.

[0016] Optionally, in some embodiments, the API information includes at least one of API creator, API creation time, API launch time, API name, API running status, API path, input parameter data, and output parameter data.

[0017] Optionally, in some embodiments, the classification information includes at least one of a classification name, a classification description, a parent classification path, and a child classification path.

[0018] The third aspect of the present application provides a vehicle, comprising: a memory, a processor, and a computer program stored in the memory and executable on the processor, wherein the processor executes the program to implement the method for managing API based on tree-structured classification as described in the above embodiment.

[0019] The fourth aspect of the present application provides a computer-readable storage medium on which a computer program is stored. The program is executed by a processor to implement the method for managing API based on tree-structured classification as described in the above embodiment.

[0020] Thus, by determining the current root node and the classification information corresponding to the current root node; based on the classification information, determining the multiple child nodes of the current root node, and obtaining the application programming interface API information of each of the multiple child nodes; based on the preset flattening processing method, obtaining the classification information of the tree structure according to the current root node, the classification information, the multiple child nodes of the current root node, and the API information of each of the multiple child nodes, and filling the classification information of the tree structure into the tree list, and displaying the filled-in tree list. Thus, the API is managed through the API path, presenting the API structure and composition of large applications, solving the problem that with the increase in APIs and the continuous increase in management costs, the relevant technology is difficult to quickly understand the structure and composition of the API of the entire application, and can classify and manage large-scale monolithic applications or microservice applications.

[0021] Additional aspects and advantages of the present application will be given in part in the description below, and in part will become apparent from the description below, or will be learned through practice of the present application. BRIEF DESCRIPTION OF THE DRAWINGS

[0022] The above and / or additional aspects and advantages of the present application will become apparent and easily understood from the following description of the embodiments in conjunction with the accompanying drawings, in which:

[0023] Figure 1 A flowchart of a method for managing APIs based on tree-structured classification according to an embodiment of the present application;

[0024] Figure 2 A schematic diagram of a tree structure provided according to an embodiment of the present application;

[0025] Figure 3 This is an ER diagram of a data table structure provided according to one embodiment of the present application;

[0026] Figure 4 A schematic diagram of a device for managing an API based on a tree-structured classification system according to an embodiment of the present application;

[0027] Figure 5 A schematic diagram of an electronic device provided according to an embodiment of the present application.

[0028] Description of reference numerals: 10 - means for managing API based on tree structure classification, 100 - determination module, 200 - acquisition module and 300 - classification module. DETAILED DESCRIPTION

[0029] The following describes in detail embodiments of the present application, examples of which are shown in the accompanying drawings, wherein the same or similar reference numerals throughout represent the same or similar elements or elements having the same or similar functions. The embodiments described below with reference to the accompanying drawings are exemplary and are intended to be used to explain the present application, and should not be construed as limiting the present application.

[0030] The following describes the method, device, equipment and medium for managing APIs based on tree structure classification according to the embodiments of the present application with reference to the accompanying drawings. In response to the problem mentioned in the above background technology that as the number of APIs increases, the management cost continues to increase, and the related technology is difficult to quickly understand the structure and composition of the API of the entire application, the present application provides a method for managing APIs based on tree structure classification. In this method, by determining the current root node and the classification information corresponding to the current root node; based on the classification information, determining multiple child nodes of the current root node, and obtaining the application programming interface API information of each child node of the multiple child nodes; based on the preset flattening processing method, according to the current root node, the classification information, the multiple child nodes of the current root node and the API information of each child node of the multiple child nodes, the classification information of the tree structure is obtained, and the classification information of the tree structure is filled into the tree list, and the filled-in tree list is displayed. In this way, the API is managed through the API path, and the API structure and composition of large applications are presented, which solves the problem that as the number of APIs increases, the management cost continues to increase, and the related technology is difficult to quickly understand the structure and composition of the API of the entire application, and can classify and manage large-scale single applications or microservice applications.

[0031] Specifically, Figure 1 A flowchart of a method for managing APIs based on tree-structured classification provided in an embodiment of the present application.

[0032] like Figure 1 As shown, the method for managing API based on tree structure classification includes the following steps:

[0033] In step S101, the current root node and the classification information corresponding to the current root node are determined.

[0034] Optionally, in some embodiments, the category information includes at least one of a category name, a category description, a parent category path, and a child category path.

[0035] It should be understood by those skilled in the art that Figure 2 As shown, Figure 2 The oval node in the middle is the root node, the rectangular node is the category node, and the cloud-shaped node is the API node. In a monolithic application, the root node's path represents the project context. The root node is a logical node and does not exist as a true category. All categories are child nodes of the root category. The child nodes of the root category are true categories, representing the top-level categories of the true categories. Top-level categories are generally used to divide project modules, and the path value is the path of that module. More specific businesses are further divided down using the top-level category as the parent category. If a subcategory currently has no interface, it is a leaf node. Specific APIs must appear as leaf nodes. The complete path of the API is the path connecting all nodes from the leaf node to the root node.

[0036] In a microservice application, the root node is / , and the service name of each module is divided into secondary categories. In each module, the interfaces of the same context are divided into the subcategories of the module, and the specific API is the leaf node.

[0037] Specifically, in an embodiment of the present application, a root node is selected, the current root node, and the classification information of the current root node are determined.

[0038] During the actual execution process, the embodiment of the present application can provide an operational page, and the developer can enter information through the interface: category name, description, parent category path, and child category path. Each time a new category is created, it is necessary to select the parent category of the category. If it is a top-level category, select the root category as the parent category. After selection, the path of the category is prefixed with the parent category path. Further input the path of the category and combine them to confirm the final path of the category. If there is no API under the category, the category is also used as a leaf node. The data table structure saved by the embodiment of the present application can be as follows Figure 3 shown.

[0039] In step S102 , multiple child nodes of the current root node are determined based on the classification information, and application programming interface (API) information of each of the multiple child nodes is obtained.

[0040] Optionally, in some embodiments, the API information includes at least one of the API creator, API creation time, API launch time, API name, API running status, API path, input parameter data, and output parameter data.

[0041] Specifically, a root node is selected, the API category is used as a child node of the root category, and the leaf node is each API.

[0042] During the actual execution process, the embodiment of the present application can provide an operational interface. Developers enter API information through the interface. The API is saved as a leaf node of a tree structure. It is necessary to select the category to which the API belongs. The path of the category to which the API belongs is the prefix of the API path. In addition, it is necessary to enter the API name, running status (online, offline), API path, input parameters, and output parameters. The creator, creation time, and online time will be automatically generated.

[0043] The input and output parameters are stored in a separate data table, identified by param_type, 1 for input parameter, 2 for output parameter, and associated with the id of the interface table through api_id, such as Figure 3 shown.

[0044] In step S103, based on the preset flattening processing method, the classification information of the tree structure is obtained according to the current root node, classification information, multiple child nodes of the current root node and API information of each child node of the multiple child nodes, and the classification information of the tree structure is filled into the tree list, and the filled-in tree list is displayed.

[0045] Optionally, in some embodiments, based on a preset flattening processing method, classification information of a tree structure is obtained according to the current root node, classification information, multiple child nodes of the current root node, and API information of each child node of the multiple child nodes, including: arranging the current root node, classification information, multiple child nodes of the current root node, and API information of each child node of the multiple child nodes in reverse order according to the target field, and if the target fields are the same, sorting them in dictionary order according to the preset classification path to obtain classification information of a tree structure; wherein, when the multiple child nodes of the current root node are stored in the preset database, the automatically generated database primary key is assigned to the target field, and when the sub-category corresponding to each child node is stored in the preset database, it is the same as the target field corresponding to each child node.

[0046] Specifically, in some embodiments, in order to facilitate the display of API classification and make the API classification path readable, the tree structure is flattened and the classification of the tree structure is displayed in the form of a list. The secondary classification (subclassification of the root node) is used as the root node of each branch. The secondary classification is first arranged in reverse order according to the creation order of the secondary classification, and then sorted according to the interface path of the classification under the secondary classification. The data table for saving the classification information is shown in FIG. Figure 3 The api_group table is described in detail below:

[0047] 1. The child node of the root category, that is, the top-level category, assigns the automatically generated database primary key id to the field root_id when it is stored in the database;

[0048] 2. For subcategories under the top-level category, the root_id stored in the database is the id of the top-level category;

[0049] 3. The categories displayed in the list are first sorted in reverse order by root_id. If the root_id is the same, they are sorted in lexicographical order by category path.

[0050] According to the method for managing APIs based on tree-structure classification proposed in the embodiment of the present application, by determining the current root node and the classification information corresponding to the current root node; based on the classification information, determining the multiple child nodes of the current root node, and obtaining the application programming interface API information of each of the multiple child nodes; based on the preset flattening processing method, obtaining the classification information of the tree structure according to the current root node, the classification information, the multiple child nodes of the current root node, and the API information of each of the multiple child nodes, and filling the classification information of the tree structure into the tree list, and displaying the filled-in tree list. In this way, the API is managed through the API path, and the API structure and composition of large applications are presented, which solves the problem that with the increase of APIs and the continuous increase of management costs, the related technology is difficult to quickly understand the structure and composition of the API of the entire application, and can classify and manage large-scale single applications or microservice applications.

[0051] Next, a device for managing API based on tree-structured classification according to an embodiment of the present application will be described with reference to the accompanying drawings.

[0052] Figure 4 It is a block diagram of a device for managing API based on a tree structure classification according to an embodiment of the present application.

[0053] like Figure 4 As shown, the tree-structured classification management API-based device 10 includes: a determination module 100 , an acquisition module 200 and a classification module 300 .

[0054] Among them, the determination module 100 is used to determine the current root node and the classification information corresponding to the current root node; the acquisition module 200 is used to determine the multiple child nodes of the current root node based on the classification information, and obtain the application programming interface API information of each child node of the multiple child nodes; and the classification module 300, based on a preset flattening processing method, obtains the classification information of the tree structure according to the current root node, classification information, multiple child nodes of the current root node and API information of each child node of the multiple child nodes, and fills the classification information of the tree structure into the tree list, and displays the filled-in tree list.

[0055] Optionally, in some embodiments, the classification module 300 is specifically used to: arrange the current root node, classification information, multiple child nodes of the current root node, and API information of each child node of the multiple child nodes in reverse order according to the target field; if the target fields are the same, sort them in dictionary order according to the preset classification path to obtain classification information with a tree structure; wherein, when the multiple child nodes of the current root node are stored in the preset database, the automatically generated database primary key is assigned to the target field, and when the sub-category corresponding to each child node is stored in the preset database, it is the same as the target field corresponding to each child node.

[0056] Optionally, in some embodiments, the API information includes at least one of the API creator, API creation time, API launch time, API name, API running status, API path, input parameter data, and output parameter data.

[0057] Optionally, in some embodiments, the category information includes at least one of a category name, a category description, a parent category path, and a child category path.

[0058] It should be noted that the aforementioned explanation of the method embodiment based on the tree-structured classification management API is also applicable to the device based on the tree-structured classification management API of this embodiment, and will not be repeated here.

[0059] According to the device for managing API based on tree-structure classification proposed in the embodiment of the present application, by determining the current root node and the classification information corresponding to the current root node; based on the classification information, determining the multiple child nodes of the current root node, and obtaining the application programming interface API information of each child node of the multiple child nodes; based on the preset flattening processing method, obtaining the classification information of the tree structure according to the current root node, the classification information, the multiple child nodes of the current root node, and the API information of each child node of the multiple child nodes, and filling the classification information of the tree structure into the tree list, and displaying the filled-in tree list. In this way, the API is managed through the API path, and the API structure and composition of large applications are presented, which solves the problem that with the increase of APIs and the continuous increase of management costs, the related technology is difficult to quickly understand the structure and composition of the API of the entire application, and can classify and manage large-scale single applications or microservice applications.

[0060] Figure 5 A schematic diagram of the structure of a vehicle provided in an embodiment of the present application. The vehicle may include:

[0061] Memory 501 , processor 502 , and computer programs stored in the memory 501 and executable on the processor 502 .

[0062] When the processor 502 executes the program, the method for managing API based on tree structure classification provided in the above embodiment is implemented.

[0063] Furthermore, the vehicle further comprises:

[0064] The communication interface 503 is used for communication between the memory 501 and the processor 502 .

[0065] The memory 501 is used to store computer programs that can be run on the processor 502 .

[0066] The memory 501 may include a high-speed RAM (Random Access Memory) memory, and may also include a non-volatile memory, such as at least one disk memory.

[0067] If the memory 501, the processor 502, and the communication interface 503 are implemented independently, the communication interface 503, the memory 501, and the processor 502 can be connected to each other via a bus and communicate with each other. The bus can be an ISA (Industry Standard Architecture) bus, a PCI (Peripheral Component Interconnect) bus, or an EISA (Extended Industry Standard Architecture) bus. The bus can be divided into an address bus, a data bus, a control bus, etc. For ease of representation, Figure 5 Only one thick line is used in the diagram, but this does not mean that there is only one bus or one type of bus.

[0068] Optionally, in a specific implementation, if the memory 501, the processor 502 and the communication interface 503 are integrated on a chip, the memory 501, the processor 502 and the communication interface 503 can communicate with each other through an internal interface.

[0069] The processor 502 may be a CPU (Central Processing Unit), or an ASIC (Application Specific Integrated Circuit), or one or more integrated circuits configured to implement the embodiments of the present application.

[0070] An embodiment of the present application also provides a computer-readable storage medium having a computer program stored thereon, which, when executed by a processor, implements the above-mentioned method for managing APIs based on tree-structured classification.

[0071] In the description of this specification, the description with reference to the terms "one embodiment", "some embodiments", "example", "specific example", or "some examples" means that the specific features, structures, materials or characteristics described in conjunction with the embodiment or example are included in at least one embodiment or example of the present application. In this specification, the schematic representations of the above terms do not necessarily refer to the same embodiment or example. Moreover, the specific features, structures, materials or characteristics described can be combined in any one or N embodiments or examples in a suitable manner. In addition, those skilled in the art can combine and combine different embodiments or examples described in this specification and features of different embodiments or examples without contradiction.

[0072] Furthermore, the terms "first" and "second" are used for descriptive purposes only and should not be understood to indicate or imply relative importance or implicitly specify the number of technical features indicated. Thus, a feature specified as "first" or "second" may explicitly or implicitly include at least one such feature. In the description of this application, "N" means at least two, for example, two, three, etc., unless otherwise specifically defined.

[0073] Any process or method description in a flowchart or otherwise described herein may be understood to represent a module, fragment or portion of code comprising one or more executable instructions for implementing the steps of a custom logical function or process, and the scope of the preferred embodiments of the present application includes alternative implementations in which functions may be performed out of the order shown or discussed, including performing functions in a substantially simultaneous manner or in reverse order depending on the functions involved, which should be understood by those skilled in the art to which the embodiments of the present application belong.

[0074] It should be understood that various parts of the present application can be implemented using hardware, software, firmware, or a combination thereof. In the above embodiment, the N steps or methods can be implemented using software or firmware stored in a memory and executed by a suitable instruction execution system. For example, if implemented using hardware, as in another embodiment, any one of the following technologies known in the art or a combination thereof can be used: a discrete logic circuit having a logic gate circuit for implementing a logic function on a data signal, an application-specific integrated circuit having a suitable combination of logic gate circuits, a programmable gate array, a field programmable gate array, etc.

[0075] Those skilled in the art will understand that all or part of the steps in the method of the above embodiment can be completed by instructing related hardware through a program, and the program can be stored in a computer-readable storage medium. When the program is executed, it includes one or a combination of the steps of the method embodiment.

[0076] Although the embodiments of the present application have been shown and described above, it can be understood that the above embodiments are exemplary and cannot be understood as limitations on the present application. Ordinary technicians in this field can change, modify, replace and modify the above embodiments within the scope of the present application.

Claims

1. A method for managing APIs based on tree-structure classification, characterized in that: The following steps are involved: Determine a current root node and classification information corresponding to the current root node; Based on the classification information, determining multiple child nodes of the current root node, and obtaining application programming interface (API) information of each of the multiple child nodes; as well as Based on a preset flattening method, obtaining classification information of a tree structure according to the current root node, the classification information, multiple child nodes of the current root node, and API information of each child node of the multiple child nodes, filling the classification information of the tree structure into a tree list, and displaying the filled tree list; Obtaining classification information in a tree structure according to the current root node, the classification information, multiple child nodes of the current root node, and API information of each child node of the multiple child nodes includes: Arrange the current root node, the classification information, multiple child nodes of the current root node, and the API information of each child node of the multiple child nodes in reverse order according to the target field. If the target fields are the same, sort them in the lexicographic order of the preset classification path to obtain the classification information in the tree structure; Among them, when multiple child nodes of the current root node are stored in the preset database, the automatically generated database primary key is assigned to the target field, and when the sub-category corresponding to each child node is stored in the preset database, it is the same as the target field corresponding to each child node.

2. The method according to claim 1, characterized in that The API information includes at least one of API creator, API creation time, API online time, API name, API running status, API path, input parameter data and output parameter data.

3. The method according to claim 1, characterized in that The classification information includes at least one of a classification name, a classification description, a parent classification path, and a child classification path.

4. A device for managing API based on tree structure classification, characterized in that: include: A determination module, configured to determine a current root node and classification information corresponding to the current root node; an acquisition module, configured to determine, based on the classification information, a plurality of child nodes of the current root node, and acquire application programming interface (API) information of each of the plurality of child nodes; as well as The classification module, based on a preset flattening processing method, obtains classification information of a tree structure according to the current root node, the classification information, multiple child nodes of the current root node, and API information of each child node of the multiple child nodes, fills the classification information of the tree structure into a tree list, and displays the filled tree list; the classification module is specifically used to: Arrange the current root node, the classification information, multiple child nodes of the current root node, and the API information of each child node of the multiple child nodes in reverse order according to the target field. If the target fields are the same, sort them in the lexicographic order of the preset classification path to obtain the classification information in the tree structure; Among them, when multiple child nodes of the current root node are stored in the preset database, the automatically generated database primary key is assigned to the target field, and when the sub-category corresponding to each child node is stored in the preset database, it is the same as the target field corresponding to each child node.

5. The device according to claim 4, characterized in that The API information includes at least one of API creator, API creation time, API online time, API name, API running status, API path, input parameter data and output parameter data.

6. The device according to claim 4, characterized in that The classification information includes at least one of a classification name, a classification description, a parent classification path, and a child classification path.

7. An electronic device, characterized in that: include: A memory, a processor, and a computer program stored in the memory and executable on the processor, wherein the processor executes the program to implement the method for managing APIs based on a tree-structured classification as described in any one of claims 1 to 3.

8. A computer-readable storage medium having a computer program stored thereon, characterized in that: The program is executed by a processor to implement the method for managing API based on tree-structure classification as described in any one of claims 1 to 3.

Images