CN117908955A - Interface document generation method, device, computing equipment and storage medium - Google Patents

Abstract

The invention discloses an interface document generation method, a device, a computing device and a storage medium, which relate to the technical field of Internet development, wherein the method is executed in the computing device and comprises the following steps: acquiring configured interface configuration information, wherein the interface configuration information comprises interface basic information, interface flow and interface parameter entering; executing interface test according to the interface configuration information to generate a test result; in the process of executing interface test, analyzing the interface input parameters to obtain an interface input parameter data structure; analyzing the test result to obtain an output parameter data structure of the interface; and generating an interface document according to the interface basic information, the input parameter data structure and the output parameter data structure. According to the technical scheme, the interface document can be automatically generated in the stage of executing the interface test, the creation flow of the interface document is simplified, and the flexibility, convenience and efficiency of creating the interface document are improved.

Description

Interface document generation method, device, computing equipment and storage medium

Technical Field

The present invention relates to the field of internet development technologies, and in particular, to an interface document generating method, an interface document generating device, a computing device, and a storage medium.

Background

The flow code platform is a visual code generation platform, and through a visual dragging flow chart and simple node configuration, the interface function is rapidly developed, tested and deployed, so that the high-efficiency support of the service requirement is realized. Wherein the interface document is one of the most important artifacts for the interface user during the development and release of the interface. In the process code platform, in order to reduce the coupling between the service lines, developers have configured hundreds of data interfaces for data interaction and function integration. In the process of delivering the interface, one of the necessary output is an interface document corresponding to the necessary output, and the interface document needs to be updated along with the change of the interface requirement.

In the prior art, the interface document is generally written manually, and the efficiency of creating the interface document is low. And when the interface is upgraded, the interface document needs to be manually modified and issued to relevant users. Along with the continuous upgrading of the interface version, the manual writing scheme is adopted to easily cause inconsistent interfaces and documents, and the later-period change and the notification of a calling party are high in cost and poor in maintainability due to uncertain factors such as personnel post change.

There is also a solution in the prior art to introduce interface document middleware, e.g., swagger, into the project. In the process of interface development, interface description, parameter entering type, parameter entering field meaning and other information are set by adding notes and other modes, so that an interface SDK can be automatically generated. The proposal can realize the upgrading of the interface document in the process of interface development, but the mode of introducing middleware and notes has larger invasiveness to projects, and can not meet the requirement of dynamically creating interface scenes, such as a flow code platform, and can not synchronously generate the interface document in the interface test stage.

For this reason, an interface document generation method is required to solve the problems existing in the above-mentioned technical solutions.

Disclosure of Invention

To this end, the present invention provides an interface document generation method and an interface document generation apparatus to solve or at least alleviate the above-mentioned problems.

According to one aspect of the present invention, there is provided an interface document generation method, executed in a computing device, comprising: acquiring configured interface configuration information, wherein the interface configuration information comprises interface basic information, interface flow and interface parameter entering; executing interface test according to the interface configuration information to generate a test result; in the process of executing interface test, analyzing the interface input parameters to obtain an interface input parameter data structure; analyzing the test result to obtain an output parameter data structure of the interface; and generating an interface document according to the interface basic information, the input parameter data structure and the output parameter data structure.

Optionally, in the method for generating an interface document according to the present invention, the step of executing an interface test according to the interface configuration information to generate a test result includes: starting an interface test interface; drawing a use case input window on the interface test interface according to the interface configuration information; acquiring a test case input in the case input window; and executing interface test according to the test case to generate a test result.

Optionally, in the method for generating an interface document according to the present invention, generating an interface document according to the interface basic information, the input parameter data structure, and the output parameter data structure includes: generating a corresponding interface parameter entering list and a corresponding interface parameter exiting list according to the parameter entering data structure and the parameter exiting data structure; and generating an interface document according to the interface basic information, the interface parameter entering list and the interface parameter exiting list.

Optionally, in the interface document generating method according to the present invention, after acquiring the configured interface configuration information, the method further includes: and storing the interface configuration information and the interface unique identifier in an associated mode.

Optionally, in the interface document generating method according to the present invention, further comprising: after the interface test is executed, judging whether the interface is changed or not; and if the interface is determined to change, synchronously updating the interface document according to the interface change.

Optionally, in the interface document generating method according to the present invention, the interface basic information includes an interface name, an interface function description, a network type, and responsible person information.

Optionally, in the interface document generating method according to the present invention, further comprising: in the process of executing interface test, the interface name, the interface function description, the network type and the responsible person information are obtained from the interface basic information of the interface configuration information so as to generate an interface document according to the interface basic information, the input parameter data structure and the output parameter data structure.

Optionally, in the interface document generating method according to the present invention, further comprising: and storing the interface document in association with the interface unique identifier.

Optionally, in the interface document generating method according to the present invention, further comprising: receiving a request for reading interface document configuration based on the interface unique identification; acquiring and analyzing the interface document corresponding to the interface unique identifier to acquire interface basic information, an input parameter data structure and an output parameter data structure in the interface document; and generating and displaying an interface document page based on the interface basic information, the input parameter data structure and the output parameter data structure.

Optionally, in the method for generating an interface document according to the present invention, a flow code platform is included in the computing device, and the flow code platform is configured to execute the method.

According to one aspect of the present invention, there is provided an interface document generation apparatus, residing in a computing device, the apparatus comprising: the system comprises an acquisition module, a configuration module and a configuration module, wherein the acquisition module is suitable for acquiring configured interface configuration information, and the interface configuration information comprises interface basic information, an interface flow and an interface parameter; the execution module is suitable for executing interface test according to the interface configuration information to generate a test result; the first analysis module is suitable for analyzing the interface input parameters in the process of executing the interface test to obtain an interface input parameter data structure; the second analysis module is suitable for analyzing the test result to obtain an output parameter data structure of the interface; and the generation module is suitable for generating an interface document according to the interface basic information, the input parameter data structure and the output parameter data structure.

According to one aspect of the invention, there is provided a computing device comprising: at least one processor; a memory storing program instructions, wherein the program instructions are configured to be adapted to be executed by the at least one processor, the program instructions comprising instructions for performing the interface document generation method as described above.

According to one aspect of the present invention, there is provided a readable storage medium storing program instructions that, when read and executed by a computing device, cause the computing device to perform the interface document generation method as described above.

According to the technical scheme of the invention, the interface document generation method is provided, the configured interface configuration information is obtained, and the interface test is executed according to the interface configuration information to generate a test result. In the process of executing the interface test, the interface input parameters can be analyzed to obtain an input parameter data structure (input schema) of the interface. After the interface test is completed to generate a test result, the output parameter data structure (output schema) of the interface can be obtained by analyzing the test result. Finally, the interface document may be generated based on the interface basic information, the in-parameter data structure and the out-parameter data structure acquired during the execution of the interface test phase. Thus, according to the technical scheme of the invention, the interface document can be automatically generated in the stage of executing the interface test, the process of creating the interface document is simplified, and the flexibility, convenience and efficiency of creating the interface document are improved.

In addition, after the interface test is executed, the interface document can be synchronously updated according to the interface change.

The foregoing description is only an overview of the present invention, and is intended to be implemented in accordance with the teachings of the present invention in order that the same may be more clearly understood and to make the same and other objects, features and advantages of the present invention more readily apparent.

Drawings

To the accomplishment of the foregoing and related ends, certain illustrative aspects are described herein in connection with the following description and the annexed drawings, which set forth the various ways in which the principles disclosed herein may be practiced, and all aspects and equivalents thereof are intended to fall within the scope of the claimed subject matter. The above, as well as additional objects, features, and advantages of the present disclosure will become more apparent from the following detailed description when read in conjunction with the accompanying drawings. Like reference numerals generally refer to like parts or elements throughout the present disclosure.

FIG. 1 shows a schematic diagram of a computing device 100 according to one embodiment of the invention;

FIG. 2 shows a flow diagram of an interface document generation method 200 according to one embodiment of the invention;

FIG. 3 shows a schematic diagram of an interface document generation apparatus 300 according to one embodiment of the invention.

Detailed Description

Exemplary embodiments of the present disclosure will be described in more detail below with reference to the accompanying drawings. While exemplary embodiments of the present disclosure are shown in the drawings, it should be understood that the present disclosure may be embodied in various forms and should not be limited to the embodiments set forth herein. Rather, these embodiments are provided so that this disclosure will be thorough and complete, and will fully convey the scope of the disclosure to those skilled in the art.

Aiming at the problems that the efficiency of creating the interface document is low and the interface document cannot be synchronously generated in the interface test stage in the prior art, the invention provides an interface document generation scheme, which is used for automatically generating the interface document in the execution interface test stage, simplifying the interface document creation flow and improving the flexibility, convenience and efficiency of creating the interface document.

FIG. 1 shows a schematic diagram of a computing device 100 according to one embodiment of the invention. As shown in FIG. 1, in a basic configuration, computing device 100 includes at least one processing unit 102 and a system memory 104. According to one aspect, the processing unit 102 may be implemented as a processor, depending on the configuration and type of computing device. The system memory 104 includes, but is not limited to, volatile storage (e.g., random access memory), non-volatile storage (e.g., read only memory), flash memory, or any combination of such memories. According to one aspect, an operating system 105 is included in system memory 104.

According to one aspect, operating system 105 is suitable, for example, for controlling the operation of computing device 100. Further, examples are practiced in connection with a graphics library, other operating systems, or any other application program and are not limited to any particular application or system. This basic configuration is illustrated in fig. 1 by those components within the dashed line. According to one aspect, computing device 100 has additional features or functionality. For example, according to one aspect, computing device 100 includes additional data storage devices (removable and/or non-removable) such as, for example, magnetic disks, optical disks, or tape. Such additional storage is illustrated in fig. 1 by removable storage device 109 and non-removable storage device 110.

As set forth hereinabove, according to one aspect, the program module 103 is stored in the system memory 104. According to one aspect, program modules 103 may include one or more applications, the invention is not limited in the type of application, for example, the application may include: email and contacts applications, word processing applications, spreadsheet applications, database applications, slide show applications, drawing or computer-aided application, web browser applications, etc.

According to one aspect, the program module 103 may comprise an interface document generation apparatus 300, the interface document generation apparatus 300 comprising a plurality of program instructions adapted to perform the interface document generation method 200 of the present invention, such that the interface document generation apparatus 300 is configured to perform the interface document generation method 200 of the present invention.

According to one aspect, the examples may be practiced in a circuit comprising discrete electronic components, a packaged or integrated electronic chip containing logic gates, a circuit utilizing a microprocessor, or on a single chip containing electronic components or a microprocessor. For example, examples may be practiced via a system on a chip (SOC) in which each or many of the components shown in fig. 1 may be integrated on a single integrated circuit. According to one aspect, such SOC devices may include one or more processing units, graphics units, communication units, system virtualization units, and various application functions, all of which are integrated (or "burned") onto a chip substrate as a single integrated circuit. When operating via an SOC, the functionality described herein may be operated via dedicated logic integrated with other components of computing device 100 on a single integrated circuit (chip). Embodiments of the invention may also be practiced using other techniques capable of performing logical operations (e.g., AND, OR, AND NOT), including but NOT limited to mechanical, optical, fluidic, AND quantum techniques. In addition, embodiments of the invention may be practiced within a general purpose computer or in any other circuit or system.

According to one aspect, the computing device 100 may also have one or more input devices 112, such as a keyboard, mouse, pen, voice input device, touch input device, and the like. Output device(s) 114 such as a display, speakers, printer, etc. may also be included. The foregoing devices are examples and other devices may also be used. Computing device 100 may include one or more communication connections 116 that allow communication with other computing devices 118. Examples of suitable communication connections 116 include, but are not limited to: RF transmitter, receiver and/or transceiver circuitry; universal Serial Bus (USB), parallel and/or serial ports.

The term computer readable media as used herein includes computer storage media. Computer storage media may include volatile and nonvolatile, removable and non-removable media implemented in any method or technology for storage of information (e.g., computer readable instructions, data structures, or program modules 103). System memory 104, removable storage 109, and non-removable storage 110 are all examples of computer storage media (i.e., memory storage). Computer storage media may include Random Access Memory (RAM), read Only Memory (ROM), electrically erasable read only memory (EEPROM), flash memory or other memory technology, CD-ROM, digital Versatile Disks (DVD) or other optical storage, magnetic cassettes, magnetic tape, magnetic disk storage or other magnetic storage devices, or any other article of manufacture that can be used to store information and that can be accessed by computing device 100. According to one aspect, any such computer storage media may be part of computing device 100. Computer storage media does not include a carrier wave or other propagated data signal.

According to one aspect, communication media is embodied by computer readable instructions, data structures, program modules 103, or other data in a modulated data signal (e.g., carrier wave or other transport mechanism) and includes any information delivery media. According to one aspect, the term "modulated data signal" describes a signal that has one or more of its characteristics set or changed in such a manner as to encode information in the signal. By way of example, and not limitation, communication media includes wired media such as a wired network or direct-wired connection, and wireless media such as acoustic, radio Frequency (RF), infrared, and other wireless media.

In an embodiment according to the invention, the computing device 100 is configured to perform the interface document generation method 200 according to the invention. The computing device 100 includes one or more processors and one or more readable storage media storing program instructions that, when configured to be executed by the one or more processors, cause the computing device to perform the interface document generation method 200 in an embodiment of the invention.

The computing device 100 executes the interface document generation method 200 in the embodiment of the invention to automatically generate the interface document in the execution interface test stage, simplify the creation flow of the interface document, and improve the flexibility, convenience and efficiency of creating the interface document.

According to one embodiment of the invention, an interface document generation apparatus 300 resides in the computing device 100, the interface document generation apparatus 300 being configured to perform the interface document generation method 200 according to the invention. The interface document generating apparatus 300 includes therein a plurality of program instructions for executing the interface document generating method 200 of the present invention, which may instruct a processor to execute the interface document generating method 200 according to the present invention.

According to one embodiment of the invention, a process code platform is included in computing device 100 that is configured to perform interface document generation method 200 of the present invention. Wherein the flow code platform is deployed with an interface document generation device 300, the interface document generation device 300 being configured to perform the interface document generation method 200 according to the invention.

It should be noted that, the process code platform may dynamically create an interface, and by executing the interface document generating method 200 of the present invention on the process code platform, the automatic generation of an interface document in the execution of the interface test stage may be realized for the scenario of dynamically creating an interface, thereby simplifying the process of creating an interface document.

FIG. 2 shows a flow diagram of an interface document generation method 200 according to one embodiment of the invention. The interface document generation method 200 is configured to be executed in the computing device 100 and may be specifically configured to be executed on a flow code platform of the computing device 100.

As shown in fig. 2, the method 200 begins at step 210.

First, in step 210, interface configuration information of a configuration is acquired. Here, the interface configuration information may include, for example, interface basic information, interface flow, and interface entry.

In some embodiments, in step 210, interface configuration information (including interface basic information, interface flow, and interface participation) configured by the developer on the flow code platform may be obtained. In one implementation, a developer may configure an interface to enter at a start node of a flow code platform.

In some embodiments, the configured interface basic information may include, but is not limited to, an interface name, an interface function description, a network type, responsible person information, and the like. The interface flow may be designed by a visualization flow designer. The interface flow specifically may include: start node entry, primary task execution operations, interface return parameters, etc.

In some embodiments, after obtaining the developer configured interface configuration information, computing device 100 (flow code platform) may store the interface configuration information in association with the interface unique identification, e.g., may store the interface configuration information in association with the interface unique identification in a storage device communicatively connected to computing device 100.

Subsequently, in step 220, the computing device 100 (flow code platform) may perform an interface test based on the interface configuration information to generate a test result.

In some embodiments, first, the computing device 100 (flow code platform) may initiate an interface test interface, and then may obtain interface configuration information from the storage device described above, and in particular, may obtain corresponding interface configuration information from the storage device based on the interface unique identification.

Then, a use case input window can be drawn on the interface test interface according to the interface configuration information. In this way, a developer can enter one or more test cases in a case entry window.

Furthermore, the test case input by the developer in the case input window can be obtained, and the interface test is executed according to the test case so as to generate a test result.

In step 230, in the process of performing the interface test, the input parameter data structure (input schema) of the interface may be obtained by parsing the input parameters of the interface.

After the interface test is completed, a test result is generated, step 240 may be performed.

In step 240, the test results may be parsed to obtain an output schema (output schema) of the interface.

Finally, in step 250, an interface document may be generated based on the interface basic information, the in-parameter data structure, and the out-parameter data structure.

In some embodiments, the interface document may specifically be a schema-based interface document. The custom interface document structure contains interface basic information, an in-parameter data structure and an out-parameter data structure through a pre-custom interface document structure (schema structure). Thus, based on the custom interface document structure, the interface document can be generated according to the interface basic information, the in-parameter data structure and the out-parameter data structure.

In some embodiments, in the process of performing the interface test, the interface name, the interface function description, the network type and the responsible person information may also be read from the interface basic information of the interface configuration information. Thus, in step 250, an interface document may be generated based on the interface basic information (e.g., interface name, interface function description, network type, responsible person information) read during execution of the interface test, the in-parameter data structure obtained in step 230, the out-parameter data structure obtained in step 240.

In some embodiments, when generating the interface document according to the interface basic information, the input parameter data structure, and the output parameter data structure in step 250, the corresponding interface input parameter list and the interface output parameter list may be generated according to the input parameter data structure (input schema) and the output parameter data structure (output schema), respectively. That is, a corresponding interface input parameter list is generated according to an input parameter data structure (input schema), and a corresponding interface output parameter list is generated according to an output parameter data structure (output schema). The interface document may then be generated based on the interface basic information, the interface entry list, and the interface exit list.

In some embodiments, after the interface document is generated, the interface document may also be stored in association with the interface unique identifier based on a custom format. For example, the interface document may be stored in association with the interface unique identification in a storage device communicatively connected to the computing device 100 based on a custom format.

In addition, in some embodiments, after the interface test is performed, whether the interface is changed can be further determined, and if the interface is determined to be changed (for example, the interface version is updated), the interface document can be synchronously updated according to the interface change. Specifically, when it is determined that the interface is changed, a reminder message for the interface document to be changed may be generated, so that a developer triggers updating of the interface document according to the reminder message. Therefore, the invention can synchronously update the interface document according to the interface change, realize the synchronous update of the interface document in the interface test and version upgrade process, and ensure that the interface document is consistent with the interface.

It should be noted that, according to the interface document generating method 200 of the present invention, the interface document may be synchronously generated each time the interface test is performed, and the generated interface document and the unique identifier of the interface may be associated and stored in the storage device. Based on this, the present invention can also read the interface document and present the interface document.

In particular, computing device 100 may receive (by a user at the flow code platform) a request to read an interface document configuration based on an interface unique identification.

Then, in response to a request to read the configuration of the interface document, the interface document corresponding to the interface unique identifier is obtained (from the storage device based on the interface unique identifier), and parsed to obtain interface basic information, an in-parameter data structure, and an out-parameter data structure in the interface document. Here, the interface basic information, the interface parameter entry list and the interface parameter exit list in the interface document can be obtained in a parsing manner. In one embodiment, the interface name, the interface function description, the network type, the responsible person information, and the like included in the interface basic information may be further parsed, the input parameter information (such as the name, the type, whether to fill, the default value, the field meaning, and the like of the input parameter) included in the interface parameter entry list is parsed, and the output parameter information (such as the type, the name, the field meaning, and the like of the output parameter) included in the interface parameter entry list is parsed.

The interface document page may then be generated and presented based on the interface basic information, the in-parameter data structure (specifically, the interface in-parameter list), and the out-parameter data structure (specifically, the interface out-parameter list). In one embodiment, an interface document page may be generated and presented based on the interface base information, the input parameter information in the interface entry list, and the output parameter information in the interface exit list. Here, the interface document page may be specifically an HTML page, where the HTML page may use a bootstrap framework layout, and support a PC end and a mobile end, and has higher availability.

In this way, the interface document page can be displayed according to the user requirement.

FIG. 3 shows a schematic diagram of an interface document generation apparatus 300 according to one embodiment of the invention. The interface document generation apparatus 300 resides in the computing device 100. In some embodiments, the interface document generation apparatus 300 may be deployed on a flow code platform of the computing device 100. The interface document generation apparatus 300 may be configured to perform the interface document generation method 200 of the present invention.

As shown in fig. 3, in an embodiment of the present invention, the interface document generating apparatus 300 includes an acquisition module 310, an execution module 320, a first parsing module 330, a second parsing module 340, and a generating module 350 that are sequentially communicatively connected.

The obtaining module 310 may obtain the configured interface configuration information, where the interface configuration information includes interface basic information, interface flow, and interface parameter. The execution module 320 may perform interface testing according to the interface configuration information to generate a test result. The first parsing module 330 may parse the access parameter during the interface test process to obtain an access parameter data structure of the interface. The second parsing module 340 may parse the test result to obtain an output data structure of the interface. The generation module 350 may generate an interface document based on the interface basic information, the in-parameter data structure, and the out-parameter data structure.

It should be noted that the obtaining module 310, the executing module 320, the first parsing module 330, the second parsing module 340, and the generating module 350 are respectively configured to execute the foregoing steps 210 to 250. Here, the specific execution logic of the obtaining module 310, the executing module 320, the first analyzing module 330, the second analyzing module 340, and the generating module 350 may be referred to the descriptions of the steps 210 to 250 in the foregoing method 200, and the descriptions are not repeated here.

According to the interface document generation method, the configured interface configuration information is obtained, and the interface test is executed according to the interface configuration information to generate a test result. In the process of executing the interface test, the interface input parameters can be analyzed to obtain an input parameter data structure (input schema) of the interface. After the interface test is completed to generate a test result, the output parameter data structure (output schema) of the interface can be obtained by analyzing the test result. Finally, the interface document may be generated based on the interface basic information, the in-parameter data structure and the out-parameter data structure acquired during the execution of the interface test phase. Thus, according to the technical scheme of the invention, the interface document can be automatically generated in the stage of executing the interface test, the process of creating the interface document is simplified, and the flexibility, convenience and efficiency of creating the interface document are improved. In addition, according to the technical scheme of the invention, after the interface test is executed, the interface document can be synchronously updated according to the interface change.

In addition, the invention also discloses: the method of any one of A1-A7, wherein further comprising: and storing the interface document in association with the interface unique identifier. The method of any one of A1-A8, wherein further comprising: receiving a request for reading interface document configuration based on the interface unique identification; acquiring and analyzing the interface document corresponding to the interface unique identifier to acquire interface basic information, an input parameter data structure and an output parameter data structure in the interface document; and generating and displaying an interface document page based on the interface basic information, the input parameter data structure and the output parameter data structure. A10, the method of any of A1-A9, wherein a flow code platform is included in the computing device, the flow code platform configured to perform the method.

The various techniques described herein may be implemented in connection with hardware or software or, alternatively, with a combination of both. Thus, the methods and apparatus of the present invention, or certain aspects or portions of the methods and apparatus of the present invention, may take the form of program code (i.e., instructions) embodied in tangible media, such as removable hard drives, U-drives, floppy diskettes, CD-ROMs, or any other machine-readable storage medium, wherein, when the program is loaded into and executed by a machine, such as a computer, the machine becomes an apparatus for practicing the invention.

In the case of program code execution on programmable computers, the mobile terminal will generally include a processor, a storage medium readable by the processor (including volatile and non-volatile memory and/or storage elements), at least one input device, and at least one output device. Wherein the memory is configured to store program code; the processor is configured to execute the interface document generation method of the present invention in accordance with instructions in said program code stored in the memory.

By way of example, and not limitation, readable media comprise readable storage media and communication media. The readable storage medium stores information such as computer readable instructions, data structures, program modules, or other data. Communication media typically embodies computer readable instructions, data structures, program modules or other data in a modulated data signal such as a carrier wave or other transport mechanism and includes any information delivery media. Combinations of any of the above are also included within the scope of readable media.

In the description provided herein, algorithms and displays are not inherently related to any particular computer, virtual system, or other apparatus. Various general-purpose systems may also be used with examples of the invention. The required structure for a construction of such a system is apparent from the description above. In addition, the present invention is not directed to any particular programming language. It will be appreciated that the teachings of the present invention described herein may be implemented in a variety of programming languages, and the above description of specific languages is provided for disclosure of enablement and best mode of the present invention.

In the description provided herein, numerous specific details are set forth. However, it is understood that embodiments of the invention may be practiced without these specific details. In some instances, well-known methods, structures and techniques have not been shown in detail in order not to obscure an understanding of this description.

Similarly, it should be appreciated that in the foregoing description of exemplary embodiments of the invention, various features of the invention are sometimes grouped together in a single embodiment, figure, or description thereof for the purpose of streamlining the disclosure and aiding in the understanding of one or more of the various inventive aspects.

Those skilled in the art will appreciate that the modules or units or components of the devices in the examples disclosed herein may be arranged in a device as described in this embodiment, or alternatively may be located in one or more devices different from the devices in this example. The modules in the foregoing examples may be combined into one module or may be further divided into a plurality of sub-modules.

Unless otherwise specified the use of the ordinal adjectives "first", "second", "third", etc., to describe a common object, merely indicate that different instances of like objects are being referred to, and are not intended to imply that the objects so described must be in a given sequence, either temporally, spatially, in ranking, or in any other manner.

Claims (10)

1. An interface document generation method, performed in a computing device, comprising:

acquiring configured interface configuration information, wherein the interface configuration information comprises interface basic information, interface flow and interface parameter entering;

Executing interface test according to the interface configuration information to generate a test result;

In the process of executing interface test, analyzing the interface input parameters to obtain an interface input parameter data structure;

analyzing the test result to obtain an output parameter data structure of the interface;

And generating an interface document according to the interface basic information, the input parameter data structure and the output parameter data structure.

2. The method of claim 1, wherein performing an interface test to generate a test result according to the interface configuration information comprises:

Starting an interface test interface;

drawing a use case input window on the interface test interface according to the interface configuration information;

acquiring a test case input in the case input window;

And executing interface test according to the test case to generate a test result.

3. The method of claim 1 or 2, wherein generating an interface document from the interface basic information, the in-parameter data structure, and the out-parameter data structure comprises:

Generating a corresponding interface parameter entering list and a corresponding interface parameter exiting list according to the parameter entering data structure and the parameter exiting data structure;

and generating an interface document according to the interface basic information, the interface parameter entering list and the interface parameter exiting list.

4. The method of any of claims 1-3, wherein after obtaining the configured interface configuration information, further comprising:

and storing the interface configuration information and the interface unique identifier in an associated mode.

5. The method of any one of claims 1-4, further comprising:

after the interface test is executed, judging whether the interface is changed or not;

and if the interface is determined to change, synchronously updating the interface document according to the interface change.

6. The method of any of claims 1-5, wherein the interface basic information includes an interface name, an interface function description, a network type, responsible person information.

7. The method of any of claims 1-6, further comprising:

In the process of executing interface test, the interface name, the interface function description, the network type and the responsible person information are obtained from the interface basic information of the interface configuration information so as to generate an interface document according to the interface basic information, the input parameter data structure and the output parameter data structure.

8. An interface document generation apparatus residing in a computing device, the apparatus comprising:

the system comprises an acquisition module, a configuration module and a configuration module, wherein the acquisition module is suitable for acquiring configured interface configuration information, and the interface configuration information comprises interface basic information, an interface flow and an interface parameter;

The execution module is suitable for executing interface test according to the interface configuration information to generate a test result;

The first analysis module is suitable for analyzing the interface input parameters in the process of executing the interface test to obtain an interface input parameter data structure;

The second analysis module is suitable for analyzing the test result to obtain an output parameter data structure of the interface;

and the generation module is suitable for generating an interface document according to the interface basic information, the input parameter data structure and the output parameter data structure.

9. A computing device, comprising:

At least one processor; and

A memory storing program instructions, wherein the program instructions are configured to be adapted to be executed by the at least one processor, the program instructions comprising instructions for performing the method of any of claims 1-7.

10. A readable storage medium storing program instructions which, when read and executed by a computing device, cause the computing device to perform the method of any of claims 1-7.