Application program interface management method, device, electronic device and storage medium

Abstract

The present invention provides an application program interface management method, device, electronic device and storage medium, wherein the application program interface management method comprises: parsing an API protocol document in a code, comparing the parsed API protocol document with a previously existing local API protocol document, determining whether the API information has changed, and if so, writing the updated API information into the previously existing local API protocol document to form the latest API protocol document; receiving the latest API protocol document, parsing the latest API protocol document, and generating a custom API object, comparing the API custom object with a previously existing API custom object in a database, determining whether there is any changed information, and if so, synchronously updating the changed information in the database.

Description

Technical Field

[0001] This article involves but is not limited to the field of application programming interfaces. Background Art

[0002] In the daily development process, especially in Internet companies, under the microservice system, there are a large number of microservices, usually thousands or even tens of thousands. With so many apps, the number of APIs generated can be imagined. However, in daily work, all demand interactions, R&D testing, quality control, etc. are completed based on APIs. Therefore, how to better manage APIs is a very big challenge.

[0003] There are many open source API management systems with different functions. Currently, there are several popular API management methods in the industry:

[0004] (1)Swagger

[0005] First, you must know the IP address of the APP, which can only be viewed when the APP is alive. In addition, because the address exposed to the outside can be changed by yourself, you need to find relevant R&D personnel to confirm the address. Secondly, API information cannot be saved and can only be viewed in real time. Secondly, because it is easy to leak all the company's API information, there are security risks and it is disabled online. Therefore, the applicable scenarios are limited.

[0006] (2) Wiki

[0007] Although it can be saved and barely used as a means of communication and interaction, the maintenance cost is very high, it needs to be written and maintained manually, and it is difficult to ensure the reliability of API information. In addition, it is impossible to express the extended information of the API (such as services, groups, organizational structure, versions, etc.), and it is even more impossible to integrate with other systems.

[0008] (3)YAPI

[0009] There are already many open source API management systems like YAPI, and many of them are very powerful. They not only support the management of API itself, but also provide online testing and mock functions. However, most of them still input API information manually, and integrate the functions of swagger doc import or markdown text import. Maintenance itself is still based on people. This inevitably leads to the low reliability and distortion of API information itself. Such distortion will cause many functions to be unreliable or unavailable when integrating between systems.

[0010] These API management methods have the following disadvantages:

[0011] First, these management methods are difficult to integrate with other systems, and in order to integrate with other company systems, a lot of secondary development work is required.

[0012] Second, most of them are based on manually maintaining API information or importing API information in a specific format, which has high management costs, and the API is easily distorted, making it difficult to ensure consistency with the code.

[0013] Third, it is impossible to automatically maintain the relationship between API and services, groups, organizational structures, etc., and it is difficult to perform quality control, demand communication, test automation, and other tasks based on API to improve R&D efficiency. The real value of API information cannot be brought into play. Summary of the invention

[0014] The following presents an overview of various exemplary technical solutions. Some simplifications and omissions may be made in the following overview, which is intended to highlight and introduce some aspects of the various exemplary technical solutions, but does not limit the scope of the present invention. A detailed description of the exemplary technical solutions sufficient to allow a person of ordinary skill in the art to generate and use the inventive concept will be presented in subsequent sections.

[0015] To solve the above technical problems, the technical solution of the present invention provides an application program interface management method, including: parsing the API protocol document in the code, comparing the parsed API protocol document with the locally existing API protocol document, determining whether the API information has changed, and if so, writing the updated API information into the locally existing API protocol document to form the latest API protocol document; receiving the latest API protocol document, parsing the latest API protocol document, and generating a custom API object, comparing the API custom object with the API custom object originally existing in the database, determining whether there is any changed information, and if so, synchronously updating the changed information in the database.

[0016] Optionally, in addition to the API parameter information, the custom API object also includes at least one of the following: APP information, grouping, lane, version, organizational structure, API logical grouping, API business grouping, and API collection.

[0017] Optionally, comparing the API custom object with an API custom object originally existing in the database includes: comparing the MD5 value of the custom API object with the MD5 value of the original custom API object in the database. The database may be remote.

[0018] Optionally, the API protocol document is a Swagger document or a Javadoc document.

[0019] Optionally, the determination of whether there is changed information is performed according to the request header, query parameters, restful parameters, and request body respectively.

[0020] Another technical solution of the present invention provides an application program interface management device, including: a plug-in module, configured to parse the API protocol document in the code, compare the parsed API protocol document with the locally existing API protocol document, determine whether the API information has changed, and if so, write the updated API information into the locally existing API protocol document to form the latest API protocol document; an API management module, configured to receive the latest API protocol document, parse the latest API protocol document, and generate a custom API object, compare the API custom object with the API custom object originally existing in the database, determine whether there is any changed information, and if so, synchronously update the changed information in the database.

[0021] Optionally, the parsing of the API protocol document in the code is automatic.

[0022] Optionally, in addition to the API parameter information, the custom API object also includes at least one of the following: APP information, grouping, lane, version, organizational structure, API logical grouping, API business grouping, and API collection.

[0023] Optionally, comparing the API custom object with an API custom object originally existing in the database includes: comparing the MD5 value of the custom API object with the MD5 value of the original custom API object in the database.

[0024] Optionally, the API protocol document is a Swagger document or a Javadoc document.

[0025] Optionally, the determination of whether there is changed information is performed according to the request header, query parameters, restful parameters, and request body respectively.

[0026] Optionally, the plug-in is a Maven plug-in.

[0027] Another technical solution of the present invention further provides an electronic device, comprising: a processor, a memory, and a computer program stored and running on the memory, wherein the processor implements the steps of the method described in any of the above technical solutions when executing the computer program.

[0028] Another technical solution of the present invention further provides a computer-readable storage medium, and when the computer program is executed by a processor, the steps of the method described in any of the above technical solutions are implemented.

[0029] The technical solution of the present invention mainly has the following beneficial effects of dough making:

[0030] First, the technical solution of the present invention is easy to integrate with other systems and does not require secondary development.

[0031] First, the technical solution of the present invention adopts a plug-in method, which can be automatically generated through a project scaffold, does not require manual intervention, and has low management costs.

[0032] Third, the technical solution of the present invention automatically maintains the relationship between API and services, groups, organizational structures, etc.

[0033] Fourthly, the technical solution of the present invention also achieves comparative uploading of API documents, which greatly reduces the pressure on back-end services. BRIEF DESCRIPTION OF THE DRAWINGS

[0034] For a better understanding of various exemplary embodiments, reference may be made to the accompanying drawings, in which:

[0035] Figure 1 A schematic diagram of a process flow of an application program interface management method provided by an embodiment is shown;

[0036] Figure 2 A schematic diagram of the structure of an application program interface management device provided in an embodiment is shown.

[0037] To facilitate understanding, the same reference numerals have been used to designate elements having substantially the same or similar structure and / or substantially the same or similar function. DETAILED DESCRIPTION

[0038] Description and drawings illustrate the principle of the present invention. Therefore, it will be appreciated that those skilled in the art will be able to design various arrangements, although the arrangement is not explicitly described or shown herein, the arrangement embodies the principle of the present invention and is included within the scope of the present invention. In addition, all examples cited herein are mainly intended to be explicitly used for teaching purposes, to help readers understand the principle of the present invention and the concepts provided by the inventors to deepen this area, and all examples should be considered as not limited to such specific cited examples and conditions. In addition, as used herein, unless otherwise indicated (e.g., "or in addition" or "or in an alternative"), the term "or" refers to non-exclusive or (i.e., and / or). Moreover, the various embodiments described herein are not necessarily mutually exclusive, because some embodiments can be combined with one or more other embodiments to form new embodiments.

[0039] Glossary:

[0040] Maven: is a project management tool that includes a project object model, a set of standards, a project lifecycle, a dependency management system, and logic for running plugin goals defined in lifecycle phases. When you use Maven, you describe your project with a well-defined project object model, and then Maven can apply cross-cutting logic from a set of shared (or custom) plugins. Maven has a lifecycle that is called when running MVN Install. This command tells Maven to perform a series of ordered steps until it reaches the specified lifecycle. One of the effects of traversing the lifecycle journey is that Maven runs many default plugin goals that accomplish tasks such as compiling and creating a JAR file.

[0041] API: (Application Programming Interface) is a set of predefined interfaces (such as functions, HTTP interfaces), or agreements that connect different components of a software system. It is used to provide a set of routines that applications and developers can access based on certain software or hardware without having to access the source code or understand the details of the internal working mechanism.

[0042] APP: (application, application service). Application service refers to the contractual service that provides application deployment, provision, management and application rental access in a centrally managed organization.

[0043] Swagger: Swagger is a standardized and complete framework for generating, describing, calling and visualizing RESTful-style Web services. Functions: 1. Automatically generate interface documentation online. 2. Functional testing.

[0044] The first embodiment provides an application program interface management method, see Figure 1 , the method comprising:

[0045] S101: Parse the API protocol document in the code, compare the parsed API protocol document with the locally existing API protocol document, determine whether the API information has changed, and if so, write the updated API information into the locally existing API protocol document to form the latest API protocol document.

[0046] The API protocol document may include multiple types, such as a Swagger document, a Javadoc document, or other custom protocols.

[0047] Specifically, first create an APP (application service, which refers to the contractual service of providing application deployment, supply, management and application rental access in a centrally managed organization), and create the protocol documents SWAGGRR, JAVA DOC, etc. through the project scaffolding. The Swagger document is used as an example below. Custom plug-ins, such as Maven plug-ins (custom forseti-maven-plugin), can be installed in the APP. Write the relevant API interface code, write the swagger annotation, and then execute the plug-in compilation (Maven compile) command.

[0048] Execute the plug-in compilation command (Maven compile). Specifically, you can first scan the @RestController class under the target path, read the Swagger annotation, traverse all classes, assemble them into Json format text, and determine whether there is a local API protocol document forseti_doc.txt. If it exists, compare it with the content of the local API protocol document forseti_doc.txt. If the API protocol document forseti_doc.txt does not exist, create and write API information. If there is a change and upload is allowed, upload it to the document server.

[0049] When the compile command is executed, the Swagger document (API description) in the code will be automatically parsed. The program will compare the contents of the currently generated document with the local API protocol document forseti_doc.txt (string comparison) (for example, whether the API parameters have changed, whether the API has been increased or decreased, etc.). If they are inconsistent, it means that the API has changed and it will be automatically uploaded to the backend API document management service. The latest API information will be written into the local API protocol document forseti_doc.txt to form the latest API protocol document. If they are consistent, it means that there is no change and it will not be uploaded. The synchronization of API information to the backend API document management service is completed.

[0050] S102: Receive the latest API protocol document, parse the latest API protocol document, generate a custom API object, compare the API custom object with the API custom object originally existing in the database, determine whether there is any changed information, and if so, synchronously update the changed information in the database.

[0051] Specifically, after the API information is synchronized to the backend API document management service, the API management module parses the swagger document and converts it into a custom API object. In addition to basic API parameter information, the custom API object also includes APP information, groups, lanes, versions, organizational structures, API logical groups, API business groups, API collections and other information.

[0052] Then, the relevant custom API object is queried from the database according to the conditions. If the relevant custom API object does not exist in the database, a newly generated custom API object is created and written. If the relevant custom API object exists in the database, the new custom object is compared with the API custom object originally existing in the database. If there is a change, the parameter information is synchronously updated in the database.

[0053] Optionally, for APIs that have changed, change events are synchronously sent to relevant persons in charge and persons who are concerned about the changes.

[0054] Optionally, when the program compares the parsed custom API object with the custom API object in the database, the MD5 Hash algorithm can be used, that is, each API has a unique MD5 identifier, and the MD5 value generation algorithm is: API + parameter and the level where the parameter is located are concatenated into a string and then MD5 is calculated. By comparing the MD5 value of the parsed custom API object with the MD5 value of the original custom API object in the database, it can be known which parameter information of the API object has changed.

[0055] Optionally, if there are changes, they can be judged according to the request header, query parameters, restful parameters, request body, etc., and written and saved to different data tables synchronously.

[0056] Optionally, after synchronizing the API information, the API will be bound to the above dimensions based on other uploaded data (grouping, APP ID, etc.) and data such as the relationship between the APP and the organizational structure synchronized from the CMDA system.

[0057] The solution of the embodiment can be easily integrated with other systems without the need for secondary development.

[0058] The solution of the embodiment adopts a plug-in method, which can be automatically generated through a project scaffold, does not require manual intervention, and has low management costs.

[0059] The solution of the embodiment automatically maintains the relationship between API and services, groups, organizational structures, etc.

[0060] The solution of the embodiment also achieves comparative uploading of API documents, greatly reducing the pressure on backend services.

[0061] The second embodiment provides an application program interface management device 200, see Figure 2 , including: a plug-in module 201 and an API management module 202.

[0062] The plug-in module 201 automatically parses the API protocol document in the code, compares the parsed API protocol document with the locally existing API protocol document, determines whether the API information has changed, and if so, writes the updated API information into the locally existing API protocol document to form the latest API protocol document, and uploads it to the API management module;

[0063] The API protocol document may include multiple types, such as a Swagger document, a Javadoc document, or other custom protocols.

[0064] Specifically, first create an APP (application service, which refers to the contractual service of providing application deployment, supply, management and application rental access in a centrally managed organization), and create the protocol documents SWAGGRR, JAVA DOC, etc. through the project scaffolding. The Swagger document is used as an example below. Custom plug-ins, such as Maven plug-ins (custom forseti-maven-plugin), can be installed in the APP. Write the relevant API interface code, write the swagger annotation (including API description), and then execute the plug-in compilation (Maven compile) command.

[0065] The plug-in module 201 executes the plug-in compilation command (Maven compile). Specifically, it can first scan the @RestController class under the target path, read the Swagger annotation, traverse all classes, assemble them into Json format text, and determine whether there is a local API protocol document forseti_doc.txt. If it exists, it is compared with the content of the local API protocol document forseti_doc.txt. If the API protocol document forseti_doc.txt does not exist, it creates and writes API information. If there is a change and upload is allowed, it is uploaded to the document server.

[0066] After executing the compilation command, the plug-in module 201 will automatically parse the Swagger document (API description) in the code. The plug-in module 201 will compare the currently generated document with the content in the local API protocol document forseti_doc.txt (string comparison) (for example, whether the API parameters have changed, whether the API has been increased or decreased, etc.). If they are inconsistent, it means that the API has changed and it will be automatically uploaded to the backend API management module 202. The latest API information is written into the local API protocol document forseti_doc.txt to form the latest API protocol document. If they are consistent, it means that there is no change and it will not be uploaded. The synchronization of API information to the backend API management module 202 is completed.

[0067] The API management module 202 receives the latest API protocol document, parses it into custom API information, generates an MD5 value using the MD5 algorithm, compares the MD5 value with the MD5 value of the custom API information originally existing in the database, determines which specific custom API information has changed, and stores the updated custom API information in the database.

[0068] Specifically, after the API information is synchronized to the backend API management module 202, the API management module 202 parses the swagger document and converts it into a custom API object. In addition to basic API parameter information, the custom API object also includes APP information, groups, lanes, versions, organizational structures, API logical groups, API business groups, API collections and other information.

[0069] Then, the relevant custom API object is queried from the database according to the conditions. If the relevant custom API object does not exist in the database, a newly generated custom API object is created and written. If the relevant custom API object exists in the database, the new custom object is compared with the API custom object originally existing in the database. If there is a change, the parameter information is updated synchronously in the database.

[0070] Optionally, for APIs that have changed, change events are synchronously sent to relevant persons in charge and persons who are concerned about the changes.

[0071] Optionally, when the program compares the parsed custom API object with the custom API object in the database, the MD5 Hash algorithm can be used, that is, each API has a unique MD5 identifier, and the MD5 value generation algorithm is: API + parameter and the level where the parameter is located are concatenated into a string and then MD5 is calculated. By comparing the MD5 value of the parsed custom API object with the MD5 value of the original custom API object in the database, it can be known which parameter information of the API object has changed.

[0072] Optionally, if there are changes, they can be judged according to the request header, query parameters, restful parameters, request body, etc., and written and saved to different data tables synchronously.

[0073] Optionally, after synchronizing the API information, the API will be bound to the above dimensions based on other uploaded data (grouping, APP ID, etc.) and data such as the relationship between the APP and the organizational structure synchronized from the CMDA system.

[0074] The third embodiment also provides an electronic device, including: a processor, a memory, and a computer program stored and running on the memory, wherein the processor implements the steps of the method of any of the above embodiments when executing the computer program, such as steps S101 to S102, or the processor implements the functions of each module / unit in the above embodiments when executing the computer program, such as the functions of units 201 to 202. The computer program can be divided into one or more modules / units, and the one or more modules / units are stored in the memory and executed by the processor. The one or more modules / units can be a series of computer program instruction segments that can perform specific functions, and the instruction segments are used to describe the execution process of the computer program in the electronic device.

[0075] The electronic device may be a mobile terminal such as a smart phone, or a computing device such as a desktop computer, a notebook, a PDA, and a cloud server. The electronic device may include, but is not limited to, a processor, a memory, and may include more or fewer components, or a combination of certain components. For example, the electronic device may also include input and output devices, network access devices, buses, etc. The processor may be a central processing unit (CPU), or other general-purpose processors, digital signal processors (DSP), application-specific integrated circuits (ASIC), field programmable gate arrays (FPGA), or other programmable logic devices, discrete gates or transistor logic devices, discrete hardware components, etc. A general-purpose processor may be a microprocessor or the processor may also be any conventional processor, etc. The memory may be an internal storage unit of the electronic device, such as a hard disk or memory of the electronic device. The memory may also be an external storage device of the electronic device, such as a plug-in hard disk, a smart memory card (SMC), a secure digital (SD) card, a flash card, etc., equipped on the electronic device. Furthermore, the memory may include both an internal storage unit of the electronic device and an external storage device.

[0076] The fifth embodiment further provides a computer-readable storage medium, and when the computer program is executed by a processor, the steps of the method of any of the above embodiments are implemented.

[0077] Each functional unit in each embodiment of the present application can be integrated into a processing unit, or each unit can exist physically separately, or two or more units can be integrated into one unit. The above-mentioned integrated unit can be implemented in the form of hardware or in the form of a software functional unit. If the integrated module / unit is implemented in the form of a software functional unit and sold or used as an independent product, it can be stored in a computer-readable storage medium. Based on this understanding, the present application implements all or part of the process in the above-mentioned embodiment method, and can also be completed by instructing the relevant hardware through a computer program. The computer program can be stored in a computer-readable storage medium, and the computer program can implement the steps of the above-mentioned various method embodiments when executed by the processor. Among them, the computer program includes computer program code, and the computer program code can be in source code form, object code form, executable file or some intermediate form, etc. The computer-readable medium may include: any entity or device capable of carrying the computer program code, recording medium, USB flash drive, mobile hard disk, magnetic disk, optical disk, computer memory, read-only memory (ROM), random access memory (RAM), electric carrier signal, telecommunication signal, and software distribution medium, etc. It should be noted that the content contained in the computer-readable medium may be appropriately increased or decreased according to the requirements of legislation and patent practice in the jurisdiction. For example, in some jurisdictions, according to legislation and patent practice, computer-readable media do not include electric carrier signals and telecommunication signals.

[0078] The technicians in the relevant field can clearly understand that for the convenience and simplicity of description, only the division of the above-mentioned functional units and modules is used as an example for illustration. In practical applications, the above-mentioned function allocation can be completed by different functional units and modules as needed, that is, the internal structure of the device can be divided into different functional units or modules to complete all or part of the functions described above. The functional units and modules in the embodiment can be integrated in a processing unit, or each unit can exist physically separately, or two or more units can be integrated in one unit. The above-mentioned integrated unit can be implemented in the form of hardware or in the form of software functional units. In addition, the specific names of the functional units and modules are only for the convenience of distinguishing each other, and are not used to limit the scope of protection of this application. The specific working process of the units and modules in the above-mentioned system can refer to the corresponding process in the aforementioned method embodiment, which will not be repeated here.

[0079] In the above embodiments, the description of each embodiment has its own emphasis. For the part that is not described or recorded in detail in a certain embodiment, please refer to the relevant description of other embodiments. Those of ordinary skill in the art can appreciate that the units and algorithm steps of each example described in conjunction with the embodiments disclosed herein can be implemented with electronic hardware, or a combination of computer software and electronic hardware. Whether these functions are performed in hardware or software depends on the specific application and design constraints of the technical solution. Professional and technical personnel can use different methods to implement the described functions for each specific application, but such implementation should not be considered to be beyond the scope of this application.

[0080] In the embodiments provided in the present application, it should be understood that the disclosed systems, electronic devices and methods can be implemented in other ways. For example, the system and electronic device embodiments described above are only schematic. For example, the division of the modules or units is only a logical function division. There may be other division methods in actual implementation, such as multiple units or components can be combined or integrated into another system, or some features can be ignored or not executed. In addition, the coupling or direct coupling or communication connection between each other shown or discussed can be through some interfaces, indirect coupling or communication connection of the system or unit, which can be electrical, mechanical or other forms. The unit described as a separate component may or may not be physically separated, and the component displayed as a unit may or may not be a physical unit, that is, it may be located in one place, or it may be distributed on multiple network units. Some or all of the units can be selected according to actual needs to achieve the purpose of the scheme of this embodiment.

[0081] The embodiments described above are only used to illustrate the technical solutions of the present application, rather than to limit them. Although the present application has been described in detail with reference to the aforementioned embodiments, a person skilled in the art should understand that the technical solutions described in the aforementioned embodiments may still be modified, or some of the technical features may be replaced by equivalents. Such modifications or replacements do not deviate the essence of the corresponding technical solutions from the spirit and scope of the technical solutions of the embodiments of the present application, and should all be included in the protection scope of the present application.

Claims

1. An application program interface management method, characterized in that: include: Parse the API protocol document in the code, compare the parsed API protocol document with the local API protocol document to determine whether the API information has changed. If there is a change, write the updated API information into the local API protocol document to form the latest API protocol document; Receive the latest API protocol document, parse the latest API protocol document, generate a custom API object, compare the custom API object with the custom API object originally existing in the database, determine whether there is any changed information, and if so, synchronously update the changed information in the database; In addition to API parameter information, the custom API object also includes at least one of the following: APP information, grouping, lane, version, organizational structure, API logical grouping, API business grouping, and API collection.

2. The application program interface management method according to claim 1, characterized in that: The API protocol document in the parsing code is automatically executed.

3. The application program interface management method according to claim 1, characterized in that: The comparing the custom API object with the custom API object originally existing in the database includes: comparing the MD5 value of the custom API object with the MD5 value of the original custom API object in the database.

4. The application program interface management method according to claim 1, characterized in that: The API protocol document is a Swagger document or a Javadoc document.

5. The application program interface management method according to claim 1, characterized in that: The determination of whether there is changed information is performed according to the request header, query parameters, restful parameters, and request body.

6. An application program interface management device, characterized in that: include: The plug-in module is configured to parse the API protocol document in the code, compare the parsed API protocol document with the locally existing API protocol document, determine whether the API information has changed, and if so, write the updated API information into the locally existing API protocol document to form the latest API protocol document; The API management module is configured to receive the latest API protocol document, parse the latest API protocol document, generate a custom API object, compare the custom API object with the custom API object originally existing in the database, determine whether there is any changed information, and if so, synchronously update the changed information in the database; In addition to API parameter information, the custom API object also includes at least one of the following: APP information, grouping, lane, version, organizational structure, API logical grouping, API business grouping, and API collection.

7. The application program interface management device according to claim 6, characterized in that: The API protocol document in the parsing code is automatically executed.

8. The application program interface management device according to claim 6, characterized in that: The comparing the custom API object with the custom API object originally existing in the database includes: comparing the MD5 value of the custom API object with the MD5 value of the original custom API object in the database.

9. The application program interface management device according to claim 6, characterized in that: The API protocol document is a Swagger document or a Javadoc document.

10. The application program interface management device according to claim 6, characterized in that: The determination of whether there is changed information is performed according to the request header, query parameters, restful parameters, and request body.

11. The application program interface management device according to claim 6, characterized in that: The plugin is a Maven plugin.

12. An electronic device, characterized in that: include: A processor, a memory, and a computer program stored and running on the memory, wherein the processor implements the method according to any one of claims 1 to 5 when executing the computer program.

13. A computer-readable storage medium, characterized in that: The computer-readable storage medium stores a computer program, and when the computer program is executed by a processor, the method according to any one of claims 1 to 5 is implemented.

Images