CN111611173A - System and method applied to micro-service engineering interface document detection - Google Patents
System and method applied to micro-service engineering interface document detection Download PDFInfo
- Publication number
- CN111611173A CN111611173A CN202010459162.7A CN202010459162A CN111611173A CN 111611173 A CN111611173 A CN 111611173A CN 202010459162 A CN202010459162 A CN 202010459162A CN 111611173 A CN111611173 A CN 111611173A
- Authority
- CN
- China
- Prior art keywords
- interface
- document
- information
- interface document
- micro
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
- 238000001514 detection method Methods 0.000 title claims abstract description 72
- 238000000034 method Methods 0.000 title claims abstract description 18
- 238000012360 testing method Methods 0.000 claims abstract description 16
- 238000004458 analytical method Methods 0.000 claims abstract description 11
- 230000001502 supplementing effect Effects 0.000 claims description 16
- 238000007726 management method Methods 0.000 claims description 7
- 230000007246 mechanism Effects 0.000 claims description 7
- 238000012550 audit Methods 0.000 claims description 4
- 238000012795 verification Methods 0.000 claims description 4
- 238000011161 development Methods 0.000 abstract description 13
- 239000013589 supplement Substances 0.000 abstract description 12
- 238000013461 design Methods 0.000 abstract description 5
- 238000012827 research and development Methods 0.000 abstract description 4
- 230000008859 change Effects 0.000 abstract description 3
- 230000008569 process Effects 0.000 description 4
- 238000004891 communication Methods 0.000 description 3
- 238000010586 diagram Methods 0.000 description 3
- 238000012423 maintenance Methods 0.000 description 3
- 238000012986 modification Methods 0.000 description 3
- 230000004048 modification Effects 0.000 description 3
- 230000001419 dependent effect Effects 0.000 description 1
- 238000005516 engineering process Methods 0.000 description 1
- 230000006872 improvement Effects 0.000 description 1
- 230000010354 integration Effects 0.000 description 1
- 238000004806 packaging method and process Methods 0.000 description 1
- 238000013441 quality evaluation Methods 0.000 description 1
- 238000013515 script Methods 0.000 description 1
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F11/00—Error detection; Error correction; Monitoring
- G06F11/36—Preventing errors by testing or debugging software
- G06F11/3668—Software testing
- G06F11/3672—Test management
- G06F11/368—Test management for test version control, e.g. updating test cases to a new software version
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F11/00—Error detection; Error correction; Monitoring
- G06F11/36—Preventing errors by testing or debugging software
- G06F11/3668—Software testing
- G06F11/3672—Test management
- G06F11/3684—Test management for test design, e.g. generating new test cases
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F11/00—Error detection; Error correction; Monitoring
- G06F11/36—Preventing errors by testing or debugging software
- G06F11/3668—Software testing
- G06F11/3672—Test management
- G06F11/3688—Test management for test execution, e.g. scheduling of test suites
Abstract
The invention provides a system and a method applied to micro service engineering interface document detection, comprising the following steps: an interface document platform and a CI/CD quality detection unit; the interface document platform comprises an interface document automatic input module and a page display module; the CI/CD quality detection unit comprises a provider jar packet updating detection module, a micro-service interface traversal module and a document detection analysis module. By the method and the device, the interface document can be automatically input only by writing annotation information according to the specification when a developer designs the interface. Meanwhile, by combining with CI/CD, the RPC interfaces in the existing interface documents and development codes are analyzed and detected before online, and new interfaces needing to supplement documents and interfaces needing to perfect and modify the documents can be detected before online engineering. And the developer is informed to supplement the document, the developer is supervised to input the document in a standard mode, and the tester supplements and maintains the interface test case in time aiming at the change information, so that the overall research and development efficiency is improved.
Description
Technical Field
The invention relates to the technical field of computers, in particular to a system and a method applied to micro-service engineering interface document detection.
Background
With the rapid development of the internet industry, the code amount developed by programmers is rapidly increased, programs are mutually called, and the interface amount is greatly increased. The following problems are that a large number of documents are often required to be written during the design of the interface, the documents are frequently changed after the writing is finished, the writing and maintenance workload of the documents is large, and the synchronization of the modification of the documents and the codes is also large; interface documentation imperfections often increase the communication costs of both parties to the interface. Similar to the app project, the front end needs to call the back end interface, the development progress of the front end is affected when the interface function is not realized, and therefore complete interface documents are needed to be used as Mock data, and the development progress of a front end page is guaranteed. For testing new interface functions by testers, the interface document is more important reference data, and the most important basis for the interface testers to know the interface is the interface document.
In order to improve development efficiency and test efficiency, an interface document platform has appeared. The original interface document management is generally that developers maintain word documents or excel forms by themselves and then browse the word documents or the excel forms for needed persons. Every person writes the document style differently, so that deviation in understanding occurs, and the situation that the interface document is lost due to the fact that developers leave jobs also occurs. And at present, interface input specifications are formulated through an interface platform, all interfaces can be inquired through the platform, and the research and development efficiency is effectively improved. The interface functions and types developed by developers are various, and interface documents are omitted. Especially, the RPC interface can be called by a developer through communication in the development process, and the written interface document is ignored.
Therefore, it is desirable to design an interface document detection system of a micro service interface to solve the problem of missing interface documents and automatically manage interface information of software development.
Disclosure of Invention
The invention provides a system and a method applied to micro-service engineering interface document detection, which at least solve the problems that the interface document in the related technology can not realize automatic management, the interface document is omitted, and the overall software research and development efficiency is low.
According to one aspect of the invention, a system applied to micro service engineering interface document detection is provided, which comprises: an interface document platform and a CI/CD quality detection unit; the interface document platform comprises an interface document automatic input module and a page display module; the CI/CD quality detection unit comprises a provider jar packet updating detection module, a micro-service interface traversal module and a document detection analysis module:
the interface document automatic input module is used for automatically inputting the interface document to the newly added and modified interface;
the provider jar package updating detection module is used for acquiring a jar package of the latest micro service project from the maven private server, and simultaneously adding or modifying a pot file of the maven to update the jar package of the micro service project;
the micro-service interface traversal module acquires services provided by micro-service engineering through zookeeper and then traverses interfaces of the services through a java reflection mechanism to acquire interface information, wherein the interface information comprises but is not limited to engineering names, interface names, request parameters and description information;
the interface document detection and analysis module is used for comparing and analyzing the interface information of the micro service engineering with the existing interface document and analyzing to obtain the interface information of the interface document needing to be newly added or modified.
Optionally, the CI/CD quality detection unit further includes a message notification module, and sends notification information of an interface document to be newly added or modified to a developer by using websocket, and then synchronously updates the notification information to a page display module of the interface document platform for page display.
Optionally, the CI/CD quality detecting unit further includes: and the interface case supplementing module is used for receiving the interface information of the interface document needing to be newly added or modified and supplementing or maintaining the interface test case.
Optionally, the interface document platform is used for interface document management, and supports automatic or manual entry of a microservice interface document, a WebAPI type interface document, and a navigation private protocol interface document.
Optionally, the page display module of the interface document platform is configured to display interface information of the interface document that needs to be newly added or modified.
According to another aspect of the present invention, there is also provided a detection method applied to a microservice engineering interface document, including:
step 1, automatically inputting documents into newly added and modified interfaces in a mode of reading engineering code annotations;
step 2, before the project code is on-line every time, acquiring a latest micro service project jar package on a maven private server, modifying a pom file of the maven and updating the jar package of the micro service project;
step 3, acquiring an engineering code interface of the latest micro service engineering, traversing the engineering code interface to acquire interface information of a specified engineering code interface, and storing the interface information in an interface information database;
step 4, comparing and analyzing the interface information in the interface information database with the existing interface document to obtain the interface information of the interface document needing to be newly added or modified;
step 5, forwarding interface information of the interface document needing to be newly added or modified through the websocket and the interface platform page;
and 6, receiving the interface information of the interface document needing to be newly added or modified, and supplementing or maintaining the interface test case.
Optionally, step 1 includes:
step 1.1, developing an interface, and writing JavaDoc comments according to interface specifications;
step 1.2, obtaining interface information on the JavaDoc annotation by using a plug-in for reading annotation of an AriRAP open source;
step 1.3, inputting the interface information into an interface document platform, wherein the state is to be audited and needs to be confirmed by a responsible person;
step 1.4, the responsible person passes the audit, and the interface information is successfully input into the interface document platform; and if the verification is not passed, the recording is abandoned and the original document information is reserved.
Optionally, step 2 includes:
step 2.1, obtaining the latest micro-service engineering jar package information from the maven private server at regular time, and updating a domain information table;
step 2.2, performing CI/CD detection before the project code is on line, and acquiring a latest micro service project jar package according to the name of the micro service project; if the jar packet is not upgraded, the micro-service engineering interface is not changed, and the detection is directly carried out; if the jar packet is upgraded, the next step is carried out;
step 2.3, automatically updating the pom file of maven according to the version number of the jar package of the latest micro service project, and updating the jar package of the latest micro service project;
and 2.4, repackaging the detection tool to obtain the latest interface information of the latest micro-service engineering code.
Optionally, step 3 includes:
step 3.1, taking out the project code interface of the service provided by the current micro-service project from the zookeeper;
and 3.2, acquiring the project code interface information of the service provided by the current micro-service project through a java reflection mechanism: project name, interface name, request parameter and description information;
and 3.2, storing the interface information into a Redis cache.
Optionally, the step 4 includes:
step 4.1, the traversed interface information is taken out from the buffer to be compared and analyzed with the existing interface document, if the interface document is not added, the interface document needs to be added, and if the interface document is changed, the interface document needs to be updated;
and 4.2, obtaining the interface document needing to be added or modified, and sending the interface document to the AMQ as a message.
Optionally, step 5 includes:
step 5.1, the interface information of the interface document needing to be supplemented or modified is taken out from the AMQ message queue: project name, interface name, request parameter and description information;
step 5.2, acquiring a responsible person according to the project name;
step 5.3, sending a notice of supplementing the interface document to a designated responsible person by using a WebSocket protocol, and displaying the notice on an interface platform page;
and 5.4, informing the interface document platform of the new interface and the interface needing to be modified.
By the method and the device, the interface document can be automatically input only by writing annotation information according to the specification when a developer designs the interface. Meanwhile, by combining with CI/CD, the RPC interfaces in the existing interface documents and development codes are analyzed and detected before online, and new interfaces needing to supplement documents and interfaces needing to perfect and modify the documents can be detected before online engineering. And informing developers to supplement documents, supervising the developers to standardize and input the documents, and supplementing the test cases of the maintenance interface in time by the testers aiming at the change information, thereby improving the overall research and development efficiency.
Drawings
The accompanying drawings, which are included to provide a further understanding of the invention and are incorporated in and constitute a part of this application, illustrate embodiment(s) of the invention and together with the description serve to explain the invention without limiting the invention. In the drawings:
FIG. 1 is a block diagram of a microservice interface-based interface document detection system according to the present invention;
FIG. 2 is a flow chart of automatic entry of an interface document of the interface document detection system based on a micro-service interface according to the present invention;
FIG. 3 is a flowchart of the CI/CD interface document detection process of the interface document detection system based on the micro service interface.
FIG. 4 is a flow chart of a message notification module of the interface document detection system based on the micro service interface according to the present invention.
Fig. 5 is a diagram illustrating new interface information and changed interface information notified to an interface document platform by a message notification module of the micro-service interface-based interface document detection system according to the present invention.
Detailed Description
The invention will be described in detail hereinafter with reference to the accompanying drawings in conjunction with embodiments. It should be noted that the embodiments and features of the embodiments in the present application may be combined with each other without conflict.
The embodiment of the invention provides a system applied to micro service engineering interface document detection, which comprises: an interface document platform and a CI/CD quality detection unit; the interface document platform comprises an interface document automatic input module and a page display module; the CI/CD quality detection unit comprises a provider jar packet updating detection module, a micro-service interface traversal module and a document detection analysis module:
the interface document automatic input module is used for automatically inputting the interface document to the newly added and modified interface;
the provider jar package updating detection module is used for acquiring a jar package of the latest micro service project from the maven private server, and simultaneously adding or modifying a pot file of the maven to update the jar package of the micro service project;
the micro-service interface traversal module acquires services provided by micro-service engineering through zookeeper and then traverses interfaces of the services through a java reflection mechanism to acquire interface information, wherein the interface information comprises but is not limited to engineering names, interface names, request parameters and description information;
the interface document detection and analysis module is used for comparing and analyzing the interface information of the micro service engineering with the existing interface document and analyzing to obtain the interface information of the interface document needing to be newly added or modified.
In this embodiment, the CI/CD quality detection unit further includes a message notification module, and sends notification information of an interface document to be newly added or modified to a developer by using websocket, and then synchronously updates the notification information to a page display module of the interface document platform for page display.
In this embodiment, the CI/CD quality detecting unit further includes: and the interface case supplementing module is used for receiving the interface information of the interface document needing to be newly added or modified and supplementing or maintaining the interface test case.
In this embodiment, the interface document platform is used for interface document management, and supports automatic or manual entry of a microservice interface document, a WebAPI type interface document, and a navigation private protocol interface document.
In this embodiment, the page display module of the interface document platform is configured to display interface information of an interface document that needs to be newly added or modified.
According to another aspect of the present invention, there is also provided a detection method applied to a microservice engineering interface document, including:
step 1, automatically inputting documents into newly added and modified interfaces in a mode of reading engineering code annotations;
step 2, before the project code is on-line every time, acquiring a latest micro service project jar package on a maven private server, modifying a pom file of the maven and updating the jar package of the micro service project;
step 3, acquiring an engineering code interface of the latest micro service engineering, traversing the engineering code interface to acquire interface information of a specified engineering code interface, and storing the interface information in an interface information database;
step 4, comparing and analyzing the interface information in the interface information database with the existing interface document to obtain the interface information of the interface document needing to be newly added or modified;
step 5, forwarding interface information of the interface document needing to be newly added or modified through the websocket and the interface platform page;
and 6, receiving the interface information of the interface document needing to be newly added or modified, and supplementing or maintaining the interface test case.
In this embodiment, the step 1 includes:
step 1.1, developing an interface, and writing JavaDoc comments according to interface specifications;
step 1.2, obtaining interface information on the JavaDoc annotation by using a plug-in for reading annotation of an AriRAP open source;
step 1.3, inputting the interface information into an interface document platform, wherein the state is to be audited and needs to be confirmed by a responsible person;
step 1.4, the responsible person passes the audit, and the interface information is successfully input into the interface document platform; and if the verification is not passed, the recording is abandoned and the original document information is reserved.
In this embodiment, the step 2 includes:
step 2.1, obtaining the latest micro-service engineering jar package information from the maven private server at regular time, and updating a domain information table;
step 2.2, performing CI/CD detection before the project code is on line, and acquiring a latest micro service project jar package according to the name of the micro service project; if the jar packet is not upgraded, the micro-service engineering interface is not changed, and the detection is directly carried out; if the jar packet is upgraded, the next step is carried out;
step 2.3, automatically updating the pom file of maven according to the version number of the jar package of the latest micro service project, and updating the jar package of the latest micro service project;
and 2.4, repackaging the detection tool to obtain the latest interface information of the latest micro-service engineering code.
In this embodiment, the step 3 includes:
step 3.1, taking out the project code interface of the service provided by the current micro-service project from the zookeeper;
and 3.2, acquiring the project code interface information of the service provided by the current micro-service project through a java reflection mechanism: project name, interface name, request parameter and description information;
and 3.2, storing the interface information into a Redis cache.
In this embodiment, the step 4 includes:
step 4.1, the traversed interface information is taken out from the buffer to be compared and analyzed with the existing interface document, if the interface document is not added, the interface document needs to be added, and if the interface document is changed, the interface document needs to be updated;
and 4.2, obtaining the interface document needing to be added or modified, and sending the interface document to the AMQ as a message.
In this embodiment, the step 5 includes:
step 5.1, the interface information of the interface document needing to be supplemented or modified is taken out from the AMQ message queue: project name, interface name, request parameter and description information;
step 5.2, acquiring a responsible person according to the project name;
step 5.3, sending a notice of supplementing the interface document to a designated responsible person by using a WebSocket protocol, and displaying the notice on an interface platform page;
and 5.4, informing the interface document platform of the new interface and the interface needing to be modified.
Some of the terms used in the present invention:
AliRAP: is a WEB interface management tool of GUI.
CI/CD: are called continuously integrated (continuos Integration) and continuously deployed (continuos deployment) for short. The method is characterized in that a series of scripts are automatically executed in the development process to reduce the probability of bug introduction in development, and manual intervention is reduced as much as possible in the process from development to deployment of new codes.
Maven private clothes: the private server is a special remote warehouse which is a warehouse service erected in a local area network and acts on the remote warehouse on the wide area network for users in the local area network to use. When a multi-person project is developed, particularly an aggregated project is developed, the project and the project need to have a dependency relationship, and the java packages which are dependent to each other can be stored through the maven private server, so that a plurality of projects can be integrated.
As shown in FIG. 1, the interface document detection system based on micro-service interface of the present invention is composed of an interface document platform and a CI/CD detection system, wherein the interface document platform has the functions of storing, managing and displaying interface documents;
the CI/CD detection system comprises a provider jar packet updating module, a micro-service interface traversal module, an interface document analysis module, a message notification module and an interface use case supplement module. The CI/CD detection system is connected by Jenkins and is responsible for quality evaluation of projects submitting CI/CD detection, including code scanning, unit testing, package name specification detection and micro-service interface document detection. The interface document detection of the micro-service interface comprises the following steps:
step 1, a programmer develops a micro-service interface, and an interface document input module automatically supplements and modifies an interface document in a code annotation reading mode; when designing and developing the interface code, a developer can input the interface document into the interface platform in a manual input mode, or can submit the code to a Git warehouse by configuring JavaDoc comments. And then packaging and compiling, and updating the jar package version in the private server.
And 2, before the project code is on-line every time, the jar packet detection module acquires the latest project jar packet on the private server, modifies the pom file of the detection project, updates the jar packet of the service provider which the detection system depends on, and ensures that the latest interface information of the background code is acquired.
And 3, the micro service interface traversal module acquires interface information, acquires an interface name and request parameter information of a specified engineering code interface according to the latest micro service provider, and stores the interface name and the request parameter information in an interface information database.
Step 4, the document detection and analysis module analyzes and compares the interface information and the interface document to obtain the interface information needing to be newly added or modified; if the programmer does not write a new interface document, CI/CD quality detection cannot be passed.
Step 5, the message notification module transmits the existing interface document problem to each project responsible person through the websocket protocol and the interface platform page real-time communication; and simultaneously informing the automatic test platform of the need of newly supplementing the interface of the interface use case and the need of maintaining and changing the interface of the interface use case.
And 6, the interface case supplement module is used for receiving supplement case information, and testers supplement the automatic interface test cases according to the information.
As shown in FIG. 2, the interface document automatic entry module of the interface document system based on the microservice interface of the present invention has a flow chart, which includes the following steps:
step 1.1, a programmer development interface writes JavaDoc comments according to interface specifications;
step 1.2, obtaining interface information by using a plug-in reading interface annotation of an AliRAP open source;
step 1.3, interface information is input into an interface document platform, the state is to be audited, and the interface document platform needs to be confirmed by a responsible person;
step 1.4, the responsible person passes the audit, and the interface information is successfully input into the interface document platform; and if the verification is not passed, the recording is abandoned and the original document information is reserved.
As shown in FIG. 3, the CI/CD interface document detection flow chart of the interface document system based on the micro-service interface of the present invention includes a provider jar package updating module, a micro-service interface traversal module, and an interface document analysis module, and the steps are as follows:
step 2.1, acquiring provider project jar package information from the maven private server at regular time, and updating a domain information table;
and 2.2, performing CI/CD detection before the project is on line, and acquiring a latest project jar package according to the project name. If the jar packet is not upgraded, the engineering micro-service interface is not changed, and the detection is directly jumped out; if the jar packet is upgraded, the next step is carried out;
step 2.3, automatically updating the pom file of the interface document detection project according to the latest jar package version number of the project, and depending on the jar package with the latest version;
and 2.4, repackaging the detection tool for acquiring the latest micro-service interface information.
Step 3.1, taking out the service provided by the current provider from the zookeeper;
step 3.2, all interface information is obtained through a java reflection mechanism: interface name, request parameter, description information;
and 3.3, storing the interface information into a Redis cache.
Step 4.1, the traversed interface information is taken out from the buffer to be compared with the existing interface document for analysis, if the interface document is not added, the interface document needs to be added, and if the interface document is changed, the interface document needs to be updated;
step 4.2 obtains the interface document needing to be added or modified as a message and sends the message to Amq message queue.
As shown in FIG. 4, the interface document system based on microservice interface of the present invention has a message notification module for notifying the development and testing personnel of the detection result, wherein the steps include:
step 5.1 takes the interface document information that needs to be supplemented or modified from the Amq message queue: engineering, interface name, request parameter and description information;
step 5.2, the interface platform management acquires a responsible person according to the project name;
step 5.3, sending a notice of supplementing the interface document to a designated responsible person by using a WebSocket protocol, and displaying the notice on an interface platform page;
and 5.4, informing the automatic interface test platform of the new interface and the interface needing to be modified.
FIG. 5 is a diagram of new interface information and changed interface information that a message notification module notifies an interface document platform according to the present invention.
By the method and the device, the interface document can be automatically input only by writing annotation information according to the specification when a developer designs the interface. Meanwhile, by combining with CI/CD, the RPC interfaces in the existing interface documents and development codes are analyzed and detected before online, and new interfaces needing to supplement documents and interfaces needing to perfect and modify the documents can be detected before online engineering. And informing developers to supplement documents, supervising the developers to standardize and input the documents, and supplementing the test cases of the maintenance interface in time by the testers aiming at the change information, thereby improving the overall research and development efficiency.
The above description is only a preferred embodiment of the present invention and is not intended to limit the present invention, and various modifications and changes may be made by those skilled in the art. Any modification, equivalent replacement, or improvement made within the spirit and principle of the present invention should be included in the protection scope of the present invention.
Claims (11)
1. A system for microservice engineering interface document detection, comprising: an interface document platform and a CI/CD quality detection unit; the interface document platform comprises an interface document automatic input module and a page display module; the CI/CD quality detection unit comprises a provider jar packet updating detection module, a micro-service interface traversal module and a document detection analysis module:
the interface document automatic input module is used for automatically inputting the interface document to the newly added and modified interface;
the provider jar package updating detection module is used for acquiring a jar package of the latest micro service project from the maven private server, and simultaneously adding or modifying a pot file of the maven to update the jar package of the micro service project;
the micro-service interface traversal module acquires services provided by micro-service engineering through zookeeper and then traverses interfaces of the services through a java reflection mechanism to acquire interface information, wherein the interface information comprises but is not limited to engineering names, interface names, request parameters and description information;
the interface document detection and analysis module is used for comparing and analyzing the interface information of the micro service engineering with the existing interface document and analyzing to obtain the interface information of the interface document needing to be newly added or modified.
2. The system of claim 1, wherein the CI/CD quality detection unit further comprises a message notification module, and the websocket is used to send notification information of the interface document to be added or modified to a developer, and then the notification information is synchronously updated to a page display module of the interface document platform for page display.
3. The system of claim 1, wherein the CI/CD quality detection unit further comprises: and the interface case supplementing module is used for receiving the interface information of the interface document needing to be newly added or modified and supplementing or maintaining the interface test case.
4. The system of claim 1, wherein the interface document platform is configured for interface document management while supporting automated or manual entry of microservice interface documents, WebAPI-type interface documents, and voyage proprietary protocol interface documents.
5. The system according to claim 1, wherein the page display module of the interface document platform is configured to display interface information of the interface document that needs to be added or modified.
6. A detection method applied to a micro service engineering interface document is characterized by comprising the following steps:
step 1, automatically inputting documents into newly added and modified interfaces in a mode of reading engineering code annotations;
step 2, before the project code is on-line every time, acquiring a latest micro service project jar package on a maven private server, modifying a pom file of the maven and updating the jar package of the micro service project;
step 3, acquiring an engineering code interface of the latest micro service engineering, traversing the engineering code interface to acquire interface information of a specified engineering code interface, and storing the interface information in an interface information database;
step 4, comparing and analyzing the interface information in the interface information database with the existing interface document to obtain the interface information of the interface document needing to be newly added or modified;
step 5, forwarding interface information of the interface document needing to be newly added or modified through the websocket and the interface platform page;
and 6, receiving the interface information of the interface document needing to be newly added or modified, and supplementing or maintaining the interface test case.
7. The method of claim 6, wherein step 1 comprises:
step 1.1, developing an interface, and writing JavaDoc comments according to interface specifications;
step 1.2, obtaining interface information on the JavaDoc annotation by using a plug-in for reading annotation of an AriRAP open source;
step 1.3, inputting the interface information into an interface document platform, wherein the state is to be audited and needs to be confirmed by a responsible person;
step 1.4, the responsible person passes the audit, and the interface information is successfully input into the interface document platform; and if the verification is not passed, the recording is abandoned and the original document information is reserved.
8. The method of claim 6, wherein the step 2 comprises:
step 2.1, obtaining the latest micro-service engineering jar package information from the maven private server at regular time, and updating a domain information table;
step 2.2, performing CI/CD detection before the project code is on line, and acquiring a latest micro service project jar package according to the name of the micro service project; if the jar packet is not upgraded, the micro-service engineering interface is not changed, and the detection is directly carried out; if the jar packet is upgraded, the next step is carried out;
step 2.3, automatically updating the pom file of maven according to the version number of the jar package of the latest micro service project, and updating the jar package of the latest micro service project;
and 2.4, repackaging the detection tool to obtain the latest interface information of the latest micro-service engineering code.
9. The method of claim 6, wherein step 3 comprises:
step 3.1, taking out the project code interface of the service provided by the current micro-service project from the zookeeper;
and 3.2, acquiring the project code interface information of the service provided by the current micro-service project through a java reflection mechanism: project name, interface name, request parameter and description information;
and 3.2, storing the interface information into a Redis cache.
10. The method of claim 6, wherein the step 4 comprises:
step 4.1, the traversed interface information is taken out from the buffer to be compared and analyzed with the existing interface document, if the interface document is not added, the interface document needs to be added, and if the interface document is changed, the interface document needs to be updated;
and 4.2, obtaining the interface document needing to be added or modified, and sending the interface document to the AMQ as a message.
11. The method of claim 6, wherein the step 5 comprises:
step 5.1, the interface information of the interface document needing to be supplemented or modified is taken out from the AMQ message queue: project name, interface name, request parameter and description information;
step 5.2, acquiring a responsible person according to the project name;
step 5.3, sending a notice of supplementing the interface document to a designated responsible person by using a WebSocket protocol, and displaying the notice on an interface platform page;
and 5.4, informing the interface document platform of the new interface and the interface needing to be modified.
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202010459162.7A CN111611173A (en) | 2020-05-27 | 2020-05-27 | System and method applied to micro-service engineering interface document detection |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202010459162.7A CN111611173A (en) | 2020-05-27 | 2020-05-27 | System and method applied to micro-service engineering interface document detection |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN111611173A true CN111611173A (en) | 2020-09-01 |
Family
ID=72197830
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202010459162.7A Pending CN111611173A (en) | 2020-05-27 | 2020-05-27 | System and method applied to micro-service engineering interface document detection |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN111611173A (en) |
Cited By (1)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN112380281A (en) * | 2020-10-30 | 2021-02-19 | 中国人寿保险股份有限公司 | Platform layer code generation method and device, electronic equipment and storage medium |
Citations (4)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN108932122A (en) * | 2018-06-19 | 2018-12-04 | 上海陆家嘴国际金融资产交易市场股份有限公司 | Interface document generation method, device, computer equipment and storage medium |
| CN110321154A (en) * | 2019-06-25 | 2019-10-11 | 北京奇艺世纪科技有限公司 | A kind of interface message methods of exhibiting, device and the electronic equipment of micro services |
| CN110333850A (en) * | 2019-05-30 | 2019-10-15 | 重庆金融资产交易所有限责任公司 | Generation method, device, computer equipment and the storage medium of interface document |
| CN110633102A (en) * | 2019-09-23 | 2019-12-31 | 山东浪潮通软信息科技有限公司 | Micro-service-framework-based interface document automatic generation method and tool |
-
2020
- 2020-05-27 CN CN202010459162.7A patent/CN111611173A/en active Pending
Patent Citations (4)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN108932122A (en) * | 2018-06-19 | 2018-12-04 | 上海陆家嘴国际金融资产交易市场股份有限公司 | Interface document generation method, device, computer equipment and storage medium |
| CN110333850A (en) * | 2019-05-30 | 2019-10-15 | 重庆金融资产交易所有限责任公司 | Generation method, device, computer equipment and the storage medium of interface document |
| CN110321154A (en) * | 2019-06-25 | 2019-10-11 | 北京奇艺世纪科技有限公司 | A kind of interface message methods of exhibiting, device and the electronic equipment of micro services |
| CN110633102A (en) * | 2019-09-23 | 2019-12-31 | 山东浪潮通软信息科技有限公司 | Micro-service-framework-based interface document automatic generation method and tool |
Cited By (1)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN112380281A (en) * | 2020-10-30 | 2021-02-19 | 中国人寿保险股份有限公司 | Platform layer code generation method and device, electronic equipment and storage medium |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| US11429365B2 (en) | Systems and methods for automated retrofitting of customized code objects | |
| US11392485B2 (en) | Auto test generator | |
| US8739150B2 (en) | Systems and methods for dynamically replacing code objects via conditional pattern templates | |
| US10621211B2 (en) | Language tag management on international data storage | |
| US20160004517A1 (en) | SOFTWARE DEVELOPMENT IMPROVEMENT TOOL - iREVIEW | |
| US8091066B2 (en) | Automated multi-platform build and test environment for software application development | |
| US20120110030A1 (en) | Software database system and process of building and operating the same | |
| CN108762743B (en) | Data table operation code generation method and device | |
| US11449414B2 (en) | Mapping test parameter data elements during heterogeneous component-based testing in a portable automation framework in both API mode and UI mode | |
| EP3314409B1 (en) | Tracing dependencies between development artifacts in a software development project | |
| CN112527382A (en) | Method for deploying pipeline engine system, method and device for continuous integration | |
| US11269712B1 (en) | Customized categorial error handling framework for heterogeneous component-based testing in a portable automation framework | |
| US20220066915A1 (en) | Controlling heterogeneous component-based testing in a portable automation framework with test scripts in both api mode and ui mode | |
| CN111611173A (en) | System and method applied to micro-service engineering interface document detection | |
| US11734134B2 (en) | Automatically locating resources using alternative locator expressions during heterogeneous component-based testing in a portable automation framework | |
| CN113672512A (en) | Code inspection rule generating method, code inspection method, device and medium | |
| JP4642553B2 (en) | Software module failure impact analysis device, failure impact analysis method, and failure impact solution program | |
| CN116932414B (en) | Method and equipment for generating interface test case and computer readable storage medium | |
| US20080066005A1 (en) | Systems and Methods of Interfacing with Enterprise Resource Planning Systems | |
| US11310680B2 (en) | Reusing provisioned resources during heterogeneous component-based testing in a portable automation framework | |
| US11894976B1 (en) | Automated predictive change analytics | |
| WO2011041246A1 (en) | Systems and methods for analyzing and transforming an application from a source installation to a target installation | |
| Zhang | Trace Visualization of Distributed and Centralized Applications | |
| Nechita | Code Docs Automation: Technical Report 2020 | |
| Sonnleitner et al. | Persistence of workflow control data in temporal databases |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination | ||
| RJ01 | Rejection of invention patent application after publication |
Application publication date: 20200901 |