CN112433753A

CN112433753A - Interface document generation method, device, equipment and medium based on parameter information

Info

Publication number: CN112433753A
Application number: CN202011337601.3A
Authority: CN
Inventors: 柏甫
Original assignee: Ping An Puhui Enterprise Management Co Ltd
Current assignee: Ping An Puhui Enterprise Management Co Ltd
Priority date: 2020-11-25
Filing date: 2020-11-25
Publication date: 2021-03-02

Abstract

The present application relates to the field of big data technologies, and in particular, to a method, an apparatus, a device, and a medium for generating an interface document based on parameter information. The method comprises the following steps: receiving a service request, wherein the service request carries an interface identifier; acquiring a source file corresponding to the interface identifier, and acquiring class data from the source file; searching parameter information corresponding to the interface identification based on the class data, wherein the parameter information comprises interface parameters and a dependency relationship between the interface parameters; and generating an interface document corresponding to the interface according to the parameter information. The interface document can be stored in the block chain, and the method can improve the efficiency of generating the interface document.

Description

Interface document generation method, device, equipment and medium based on parameter information

Technical Field

The present application relates to the field of big data technologies, and in particular, to a method, an apparatus, a device, and a medium for generating an interface document based on parameter information.

Background

The interface plays a very important role in front end and background, different systems or testing and developers, interface documents can be dynamically and rapidly generated from verification of input parameters, dependence of parameters and generation results of output parameters of the interface, so that testers can accurately know data testing of various scenes, unnecessary communication among the testers and time for maintaining the documents of the developers are reduced, and efficiency can be greatly improved.

Interface management technologies, such as OpenApi, exist in conventional technologies, which need to rely on developers to interpret codes to provide access information corresponding to an interface, resulting in inefficient parameter data acquisition.

Disclosure of Invention

In view of the foregoing, it is desirable to provide a method, an apparatus, a computer device, and a storage medium capable of improving interface document generation efficiency.

A method for generating an interface document based on parameter information comprises the following steps:

receiving a service request, wherein the service request carries an interface identifier;

acquiring a source file corresponding to the interface identifier, and acquiring class data from the source file;

based on the class data, searching parameter information corresponding to the interface identifier, wherein the parameter information comprises interface parameters and a dependency relationship between the interface parameters, the interface parameters comprise interface input parameters and interface output parameters corresponding to the interface input parameters, and the dependency relationship comprises at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters and a dependency relationship between the interface input parameters and the interface output parameters;

and generating an interface document corresponding to the interface according to the parameter information.

In one embodiment, generating an interface document corresponding to the interface according to the parameter information includes:

determining a parameter scene according to a parameter value corresponding to an interface input parameter;

determining scene input parameters corresponding to the parameter scene from the interface input parameters corresponding to the interface identification, and acquiring scene output parameters and scene dependency relations corresponding to the scene input parameters from the interface output parameters and dependency relations corresponding to the interface identification;

and generating a scene interface document corresponding to the parameter scene according to the scene input parameters, the scene output parameters and the scene dependency relationship.

In one embodiment, when the number of the interface input parameters is more than one, generating an interface document corresponding to the interface according to the parameter information includes:

grouping each interface input parameter to obtain a plurality of groups of interface input parameters;

acquiring interface output parameters and a dependency relationship corresponding to the interface input parameters in each group, wherein the dependency relationship comprises at least one of the dependency relationship among the interface input parameters, the dependency relationship among the interface output parameters and the dependency relationship among the interface input parameters and the interface output parameters, and generating a group interface document corresponding to each group based on the interface input parameters, the interface output parameters and the dependency relationship in each group;

and generating a plurality of groups of interface documents corresponding to the interface identifiers according to the grouping interface documents corresponding to each group.

In one embodiment, grouping the input parameters of each interface to obtain a plurality of groups of input parameters includes:

acquiring the parameter level corresponding to each interface input parameter;

and grouping the interface input parameters according to the parameter levels to obtain multiple groups of interface input parameters.

In one embodiment, acquiring interface output parameters and a dependency relationship corresponding to the interface input parameters in each group, where the dependency relationship includes at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters, and a dependency relationship between the interface input parameters and the interface output parameters, and generating a group interface document corresponding to the group based on the interface input parameters, the interface output parameters, and the dependency relationship in each group, includes:

acquiring a parameter value corresponding to an interface input parameter in each group, and determining a grouping scene corresponding to each group according to the parameter value;

acquiring grouping scene input parameters corresponding to each grouping scene from the interface input parameters, acquiring grouping scene output parameters corresponding to the grouping scene input parameters and grouping scene dependency relations, wherein the grouping scene dependency relations comprise at least one of dependency relations among the grouping scene input parameters, dependency relations among the grouping scene output parameters and dependency relations among the grouping scene input parameters and the grouping scene output parameters, and generating grouping scene interface documents corresponding to the grouping scenes according to the grouping scene input parameters, the grouping scene output parameters and the grouping scene dependency relations;

and generating a grouping interface document corresponding to each grouping according to the grouping scene interface document corresponding to each grouping scene, and storing the grouping interface document in the node of the block chain clock.

In one embodiment, the method further comprises:

acquiring a service updating request, wherein the service updating request carries updating data;

and editing the class data in the source file according to the updating data, wherein the editing processing comprises at least one of adding data and deleting data to the class data.

An interface document generation apparatus based on parameter information, the apparatus comprising:

the receiving module is used for receiving a service request, and the service request carries an interface identifier;

the acquisition module is used for acquiring a source file corresponding to the interface identifier and acquiring class data from the source file;

the searching module is used for searching parameter information corresponding to the interface identification based on the class data, wherein the parameter information comprises interface parameters and a dependency relationship between the interface parameters, the interface parameters comprise interface input parameters and interface output parameters corresponding to the interface input parameters, and the dependency relationship comprises at least one of the dependency relationship between the interface input parameters, the dependency relationship between the interface output parameters and the dependency relationship between the interface input parameters and the interface output parameters;

and the first generation module is used for generating an interface document corresponding to the interface according to the parameter information.

A computer device comprising a memory storing a computer program and a processor implementing the steps of the method in any of the above embodiments when the processor executes the computer program.

A computer-readable storage medium, on which a computer program is stored which, when being executed by a processor, carries out the steps of the method of any of the above embodiments.

The interface document generation method, device, equipment and medium based on the parameter information receive a service request, wherein the service request carries an interface identifier; acquiring a source file corresponding to the interface identifier, and acquiring class data from the source file; based on the class data, searching parameter information corresponding to the interface identifier, wherein the parameter information comprises interface parameters and a dependency relationship between the interface parameters, and generating an interface document corresponding to the interface according to the parameter information. The interface document obtained by the parameter information-based interface document generation method not only comprises the interface input parameters and the interface output parameters corresponding to the interfaces, but also comprises the dependency relationship between the interface input parameters and the interface output parameters, so that the relationship between different parameters is more clear and intuitive, and the efficiency and the accuracy of obtaining the parameter information corresponding to the interfaces are improved.

Drawings

FIG. 1 is a diagram of an application environment of a method for generating an interface document based on parameter information in one embodiment;

FIG. 2 is a flowchart illustrating a method for generating an interface document based on parameter information according to an embodiment;

FIG. 3 is a flowchart illustrating generation of a scenario interface document based on a parameter scenario, provided in one embodiment;

FIG. 4 is a schematic flow diagram illustrating the generation of a packet interface document in one embodiment;

FIG. 5 is a block diagram showing an arrangement of an interface document generating apparatus based on parameter information according to an embodiment;

FIG. 6 is a diagram illustrating an internal structure of a computer device according to an embodiment.

Detailed Description

In order to make the objects, technical solutions and advantages of the present application more apparent, the present application is described in further detail below with reference to the accompanying drawings and embodiments. It should be understood that the specific embodiments described herein are merely illustrative of the present application and are not intended to limit the present application.

The interface document generation method based on parameter information provided by the application can be applied to computer equipment, and the computer equipment can be a server or a terminal, which is not limited in the application. In one embodiment, the interface document generation method based on parameter information of the present application can be applied to an application environment as shown in fig. 1, in which a terminal 102 communicates with a server 104 through a network to generate an interface document. Specifically, the server 104 receives a service request sent by the terminal 102, where the service request carries an interface identifier; acquiring a source file corresponding to the interface identifier, and acquiring class data from the source file; based on the class data, searching parameter information corresponding to the interface identifier, wherein the parameter information comprises interface parameters and a dependency relationship between the interface parameters, the interface parameters comprise interface input parameters and interface output parameters corresponding to the interface input parameters, and the dependency relationship comprises at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters and a dependency relationship between the interface input parameters and the interface output parameters; and generating an interface document corresponding to the interface according to the parameter information. The terminal 102 may be, but not limited to, various personal computers, notebook computers, smart phones, tablet computers, and portable wearable devices, and the server 104 may be implemented by an independent server or a server cluster formed by a plurality of servers.

In one embodiment, as shown in fig. 2, an interface document generating method based on parameter information is provided, which is described by taking the application of the interface document generating method based on parameter information to the server in fig. 1 as an example, and includes the following steps:

step 202, receiving a service request, where the service request carries an interface identifier.

The service request may be a request for generating an interface document corresponding to a certain interface. Specifically, the server may receive a service request sent by the user terminal, or may automatically generate the service request in the server or the terminal (specifically, the service request may be generated periodically in the server or the terminal). The interface identifier may be used to uniquely identify an interface, and for example, the interface identifier may be information such as an interface address, an interface ID, and the like, which is not limited herein.

Step 204, obtaining a source file corresponding to the interface identifier, and obtaining class data from the source file.

The source file may specifically be source code, and the class data may be defined and generated in the source file. Specifically, the class data defines in advance the interface input parameters, the interface output parameters, and the dependency relationships between the interface input parameters and the interface output parameters of each interface.

Specifically, parameter information of the interface, such as entry and exit of the interface, may be developed in advance in the meter server and declared as a class, and each attribute of the parameter or dependency inertia (dependency relationship) is defined in detail in the class, thereby obtaining class data. According to the method and the device, the standard is compiled through the standard code, then the parameter information corresponding to the interface is automatically extracted from the standard code, and then the interface document corresponding to the interface is automatically generated, so that convenience is brought to relevant personnel to check the corresponding interface information.

In a specific service scene, the change frequency of company personnel is high, after the scheme generated by the interface is improved, developers and testers can quickly judge the interface, the repeated code-flipping of the developers is reduced, the use scenes of the parameters are checked, the communication between the testers and the developers is reduced, the cases of different scenes can be more clearly written, so that the development is more focused on the development, the testing is more focused on the testing, and the working efficiency is integrally improved.

And the automatic generation of the interface can reduce the maintenance time of developers and the development time of the interface reuse. And the readability of the interface document structure for automatically generating different input parameters (interface input parameters) and output parameters (interface output parameters) according to the annotations is high. The specific implementation of the function mainly depends on the annotation, and the dependency relationship between the input parameters and the output parameters can be stated by adding the 'dependency' annotation.

And step 206, searching parameter information corresponding to the interface identifier based on the class data, wherein the parameter information comprises interface parameters and a dependency relationship between the interface parameters, the interface parameters comprise interface input parameters and interface output parameters corresponding to the interface input parameters, and the dependency relationship comprises at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters, and a dependency relationship between the interface input parameters and the interface output parameters.

The interface input parameters are parameters that the interface can receive, and specifically may be one or more of parameters such as a city, a name, an identification number, and the like, and the interface output parameters are parameters corresponding to the interface input parameters. It should be noted that different interface input parameters may correspond to the same or different interface output parameters, and the same interface input parameter may also correspond to the same or different interface output parameters in different application scenarios, which is not limited herein. In one embodiment, when the interface input parameter corresponds to a city, the corresponding interface output parameter may be a geographic location where the city is located, or in another embodiment, when the interface input parameter corresponds to a city, the corresponding interface output parameter may be a geographic location where the city is located and demographic information corresponding to the city. In one embodiment, when the parameter value corresponding to the interface input parameter is Beijing, the corresponding interface output parameter is North China and population density, and when the interface input parameter corresponds to inner Mongolia, the corresponding interface output parameter is northwest China. That is, when the parameter value of the interface input parameter is the beijing scene, the corresponding interface output parameter includes the geographic location and the demographic information, and when the interface output parameter corresponds to the inner Mongolia scene, the corresponding interface output parameter includes only the geographic location and does not include the demographic information.

The dependency relationship refers to a dependency relationship between different parameters (interface input parameters or interface output parameters), and may specifically include a dependency relationship between different interface input parameters, a dependency relationship between different interface output parameters, or a dependency relationship between an interface input parameter and an interface output parameter. Specifically, the dependency relationship may include a correlation relationship between the parameters and an unrelated relationship, where the correlation relationship may include a direct correlation relationship and an indirect correlation relationship. Specifically, when the parameters are related, it is indicated that different parameters are dependent on each other, that is, the existence of the parameters must be the same as the parameters, and thus the method has practical significance. The irrelevant relation between the parameters means that the existence of the parameters exists in isolation, and the irrelevant relation does not exist, such as the existence of the parameter C and the existence of the parameter D have no influence. Furthermore, the actual relationship between different parameters can be accurately obtained through the dependency relationship, and the accuracy and the efficiency of acquiring corresponding parameter information in a corresponding scene are improved.

In a specific embodiment, the server searches for an interface input parameter corresponding to the interface identifier, an interface output parameter corresponding to the interface input parameter, and a dependency relationship between the interface input parameter and the interface output parameter based on the class data.

And step 208, generating an interface document corresponding to the interface according to the interface input parameters, the interface output parameters and the dependency relationship.

The interface document comprises parameter information of the corresponding interface. The parameter information may specifically include interface input parameters, interface output parameters, and a dependency relationship between the parameters. If the parameter input information is the user number and the relation with the user, the corresponding parameter output information is the address and the annual income, and the dependency relationship among the parameters is that when the interface input information comprises the relation with the user, the corresponding parameter output information comprises the annual income, otherwise, the corresponding parameter output information does not comprise the annual income.

It should be noted that the interface plays a significant role in front-end and background, between different systems, or in test and developer. Interface documents can be dynamically and rapidly generated from verification of the input parameters, dependence of the parameters and generation results of the output parameters, so that testers can be helped to accurately know data tests of scenes, unnecessary communication among the testers and time for maintaining the documents of developers are reduced, and efficiency can be greatly improved. Although more and more solutions are available in the market, more reliable, easier maintenance or more visual interface management schemes such as openApi can be provided, the technology only states whether names or names of parameters are necessary, does not indicate the dependency relationship between the parameters, does not generate the parameters of the interface, is not intuitive to use, and changes of personnel only bring repeated work and indirectly increase the cost when certain parameters are needed under certain scenes or depend on the interpretation and supply of the parameters through codes by developers.

The interface document provided in the above embodiment includes not only the input parameter (interface input parameter) and the output parameter (interface output parameter) corresponding to each interface, but also the dependency relationship between the parameters. Compared with the traditional technology that all parameter information about the interface is directly acquired according to the interface, the dependency relationship between the parameters is not distinguished. For example, in the conventional technology, all input parameters and output parameters corresponding to the output interface are included, but the dependency relationship between different parameters is not included, so that the relationship between the parameters is ambiguous, the parameter information is not intuitive, and the usability is not strong. The interface document obtained by the scheme of the application not only comprises parameter input information and parameter output information, but also comprises the dependency relationship among the parameters, so that the relationship among the parameters is more clear and intuitive, the method and the device are suitable for various scenes, and the efficiency and the accuracy of parameter information acquisition are improved.

In one embodiment, as shown in FIG. 3, a flowchart for generating a scenario interface document based on a parametric scenario is provided. Specifically, generating an interface document corresponding to the interface according to the parameter information includes:

step 302, determining a parameter scene according to a parameter value corresponding to an interface input parameter.

The interface input parameter may specifically be a city, and the parameter value corresponding to the interface input parameter may specifically be a name of the city, such as Chongqing city, Zhuhai city, Shanghai city, or the like. The parameter scene can be determined according to the parameter value, for example, when the parameter value corresponds to the zhhai city, the corresponding parameter scene at this time can be the zhhai city scene, and when the parameter value corresponds to the Chongqing city, the corresponding parameter scene at this time can be the Chongqing city scene. It should be noted that, based on the same interface, the dependency relationships between the corresponding parameter input information, parameter output information, and parameters in different parameter scenarios may be the same or different. The corresponding parameter scene is determined by inputting the parameter value corresponding to the parameter through the interface, and the parameter information corresponding to the parameter scene can be directly obtained, so that the parameter information is associated with the parameter scene, and the obtaining of the parameter information is more targeted and accurate.

Step 304, determining a scene input parameter corresponding to the parameter scene from the interface input parameters corresponding to the interface identifier, and obtaining a scene output parameter and a scene dependency corresponding to the scene input parameter from the interface output parameter and the dependency corresponding to the interface identifier.

In a specific embodiment, based on the same interface, there may be a difference in the dependency relationship between corresponding interface parameter input information, interface parameter output information, and parameters (interface input parameters or interface output parameters) in different scenarios. In order to realize the reusability of the interface in different scenes, different scenes and corresponding scene parameters may be specifically configured and associated in advance. Therefore, in an actual application scenario, parameter information (interface input parameters, interface output parameters, dependency between interface input parameters, dependency between interface output parameters, or dependency between interface input parameters and interface output parameters) corresponding to a parameter scenario may be obtained according to a specific parameter scenario.

And step 306, generating a scene interface document corresponding to the parameter scene according to the scene input parameters, the scene output parameters and the scene dependency relationship.

Say the scenario corresponds to: and searching for the information of the Chongqing city, and for the scene, directly searching for all the parameter information corresponding to the Chongqing city from the preconfigured source file. For another example, enter a query in the front page: the first-level parameter-city celebration can inquire all interface input parameter and interface output parameter information about the city celebration from a source file, at the moment, a user inputs the second-level parameter-city celebration + record information at the front end, at the moment, the parameter information matched with the second-level parameter can be inquired, and the analogy is repeated, so that the interface document can be automatically generated.

In another embodiment, the online escort service is specifically corresponding to an online escort service scene, and specifically, the online escort service can be in data connection with a door of a housing part of a corresponding region, so that when an interface is opened to different regions, interface input information required by different regions is different, and therefore interface documents corresponding to different regions need to be distinguished for the same interface. In a specific embodiment, when the interface input parameter corresponds to zhhai city, the interface document corresponding to the zhhai region should be correspondingly acquired at this time, so as to acquire the interface parameter data of the zhhai region according to the interface document corresponding to the zhhai region. Specifically, when the interface input information corresponds to zhushai city, the corresponding interface input parameters may include property certificate information. When the interface input parameter corresponds to the Chongqing city, the interface document corresponding to the Chongqing city is correspondingly acquired at the moment, so that the interface parameter data of the Chongqing city is acquired according to the interface document corresponding to the Chongqing city. Specifically, when the interface corresponds to the Chongqing city, the corresponding interface input parameters do not include the property certificate information, which indicates that the Zhuhai city needs the property certificate information, and the Chongqing city does not need the property certificate information. The corresponding interface documents in different parameter scenes are proved to be different.

The interface document provided in the above embodiment includes not only the entry and exit corresponding to each interface, but also the dependency relationship between the parameters. Compared with the traditional technology that all parameter information about an interface is directly acquired according to the interface, different scenes are not distinguished firstly, and the dependency relationship among parameters is not existed secondly. For example, in the conventional technology, all input parameters and output parameters corresponding to the output interface are included, but the dependency relationship between different parameters is not included, so that the relationship between the parameters is ambiguous, the parameter information is not intuitive, and the usability is not strong. The interface document obtained by the scheme of the application not only comprises parameter input information and parameter output information, but also comprises the dependency relationship among the parameters, so that the relationship among the parameters is more clear and intuitive, the method and the device are suitable for various scenes, and the efficiency and the accuracy of parameter information acquisition are improved.

In the above embodiment, the server can automatically acquire the scene input information, the scene output information and the scene dependency relationship corresponding to the parameter scene, and further can automatically generate the scene interface document corresponding to the corresponding scene. The structure readability of the scene interface document for generating different input and output parameters according to different scenes is high, and the efficiency of acquiring interface parameter information by a user is improved.

In one embodiment, when the number of the interface input parameters is more than one, generating an interface document corresponding to the interface according to the parameter information includes: grouping each interface input parameter to obtain a plurality of groups of interface input parameters; acquiring interface output parameters and a dependency relationship corresponding to the interface input parameters in each group, wherein the dependency relationship comprises at least one of the dependency relationship among the interface input parameters, the dependency relationship among the interface output parameters and the dependency relationship among the interface input parameters and the interface output parameters, and generating a group interface document corresponding to each group based on the interface input parameters, the interface output parameters and the dependency relationship in each group; and generating a plurality of groups of interface documents corresponding to the interface identifiers according to the grouping interface documents corresponding to each group.

Specifically, the grouping process refers to a process of dividing interface input parameters corresponding to the interfaces into different groups. For example, the logic corresponding to the grouping processing may be to group and divide the interface input parameters according to the geographical location, or the grouping processing logic may be to group and divide the interface input parameters according to the parameter level. In different scenarios, the corresponding grouping processing logic can be reasonably determined according to specific requirements, and the grouping is divided according to the specific grouping processing logic.

In a particular embodiment, the interface input parameters are grouped according to geographic location. Specifically, the server obtains all interface input parameters corresponding to the interface identifier, determines parameter values corresponding to the interface input parameters, and performs group division on the interface input parameters by judging geographical positions corresponding to the parameter values. If the geographic position corresponds to the north China area, the corresponding interface input parameters are divided into the north China area group, and if the geographic position corresponds to the south China area, the corresponding interface input parameters are divided into the south China area.

In a specific embodiment, grouping the input parameters of each interface to obtain a plurality of groups of input parameters includes: acquiring the parameter level corresponding to each interface input parameter; and grouping the interface input parameters according to the parameter levels to obtain multiple groups of interface input parameters.

The parameter level corresponds to the priority of the parameter, the specific parameter with higher priority is the parameter which needs to be utilized at an earlier time, the range of the parameter with higher priority is larger, the parameter with lower priority is the parameter which needs to be utilized at a later time, and the range of the parameter with lower priority is smaller. In an actual scene, the parameters can be divided into first-level parameters, second-level parameters and the like according to the parameter levels corresponding to the parameters, and the parameters at the same level can also be divided into the same group. The parameters of different levels correspond to the same or different parameter output information and the dependency relationship between the parameters. For example, when generating the interface document corresponding to the interface, the level interface document corresponding to the corresponding parameter level may be generated according to different parameter levels, and finally, the interface document corresponding to the interface is generated according to the level interface document. It can be understood that, since the parameter levels are divided into a plurality of levels, the corresponding interface document is a multi-level interface document.

In a specific embodiment, when the interface identifier corresponds to more than one interface input parameter, the method further comprises: acquiring the parameter level corresponding to each interface input parameter; for each parameter level, acquiring an interface output parameter corresponding to an interface input parameter of the parameter level and a dependency relationship between the interface input parameter and the interface input parameter, and generating a level interface document corresponding to the parameter level; and generating a multi-level interface document corresponding to the interface identifier according to the level interface document corresponding to each parameter level.

Specifically, the interface input parameters may include more than one parameter, and different parameters may also have different parameter levels, generally, the fewer the definition conditions of the parameters with higher parameter levels are, the corresponding parameter with the largest range is, the more information obtained according to the definition conditions is, the more the parameters with lower parameter levels are, the corresponding definition conditions are, and at this time, the more specific information is obtained corresponding to the parameters with smaller ranges and more specific ranges. If the parameter with the largest parameter level can be the user number, all the parameter information corresponding to the user can be obtained according to the corresponding user number, and the parameter with the smaller parameter level can correspond to the brother and sister of the user, so that the corresponding information only comprises the brother and sister of the user corresponding to the user number.

In specific implementation, the parameter information corresponding to the parameter of each level can be searched according to the multi-level interface document, so that the efficiency of acquiring the parameter information of the corresponding interface by a user is improved.

In a specific embodiment, the parameters at different levels may also be combined in a preset manner to form target interface input parameters, and further, parameter information corresponding to the target interface input parameters, such as target interface output information, and a dependency relationship between the parameters, may be obtained from the source file.

In the above embodiment, the interface input parameters at multiple levels may also be combined to obtain the target interface input parameters, and then the target interface output parameters corresponding to the target interface input parameters and the target dependency relationship may be obtained from the source file, so that the corresponding parameter information between different target interface input parameters may be flexibly obtained, and the accuracy of obtaining the parameter information is improved.

In an embodiment, referring to fig. 4, fig. 4 is a schematic flowchart of a flow for generating a packet interface document provided in an embodiment, specifically, acquiring interface output parameters and a dependency relationship corresponding to interface input parameters in each packet, where the dependency relationship includes at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters, and a dependency relationship between the interface input parameters and the interface output parameters, and generating the packet interface document corresponding to the packet based on the interface input parameters, the interface output parameters, and the dependency relationship in each packet includes:

step 402, obtaining a parameter value corresponding to an interface input parameter in each group, and determining a grouping scene corresponding to each group according to the parameter value.

In particular, each packet may include one or more interface input parameters, and different interface input parameters may correspond to the same or different parameter scenarios. Thus, each packet may correspond to one or more packet scenarios. For example, Shandong scenes and Anhui scenes are distinguished in North China groups, and the interface document is further refined, so that the obtained interface document is clearer and readable in structure, and the efficiency of acquiring parameter information in the interface is improved.

Step 404, obtaining a grouping scene input parameter corresponding to each grouping scene from the interface input parameters, and obtaining a grouping scene output parameter and a grouping scene dependency corresponding to the grouping scene input parameter, where the grouping scene dependency includes at least one of a dependency between grouping scene input parameters, a dependency between grouping scene output parameters, and a dependency between a grouping scene input parameter and a grouping scene output parameter, and generating a grouping scene interface document corresponding to the grouping scene according to the grouping scene input parameter, the grouping scene output parameter, and the grouping scene dependency.

Specifically, a grouping scene input parameter, a grouping scene output parameter and a dependency corresponding to a grouping scene corresponding to each grouping scene are obtained, where the dependency includes one or more of a dependency between different grouping scene input parameters, a dependency between different grouping scene output parameters, or a dependency between a grouping scene input parameter and a grouping scene output parameter.

Step 406, generating a grouping interface document corresponding to each grouping according to the grouping scene interface document corresponding to each grouping scene, and storing the grouping interface document in the node in the block chain.

Specifically, each group can correspond to one or more scenes, so that the interface document with the multi-scene structure is formed in each group by constructing the interface document according to the scenes again in each group, readability of the interface document is improved, and obtaining efficiency of the interface parameter information is improved. It should be emphasized that, in order to further ensure the privacy and security of the interface document data, the data may also be stored in a node of a block chain.

In a specific embodiment, for an interface providing personal information, querying different persons may require different entries and different outputs. And combining the table I to judge scenes according to the parameter values to generate an interface document containing the input parameter and the output parameter. The method specifically comprises the following steps: first, the entry and exit declarations of the development interface are a class, and the attributes of the parameters or the dependent inertia are defined in detail in the class. In the implementation, the parameter value of one parameter a is multiple, each parameter value represents a parameter scene, and the requirements of each parameter value for other parameters are different, whether the parameters need to be filled and the parameter-taking result is different.

In a specific embodiment, the corresponding scenario is information of a query spouse, and the parameter information to be provided at this time includes: the certificate number of the spouse (coming out for annual income), when the corresponding scene is the information of brothers and sisters needing to be inquired, the parameter information needed to be provided at the moment comprises: a certificate number or name (no annual income for participation). It can be known that, for the same interface, there is a difference in the corresponding parameter information based on different scenarios.

In addition, in practical application, the same interface can be reused in various scenes, so that the display of the interface document can also display multi-level interface documents according to the value (various scenes) of a certain parameter, the dependency relationship between the input parameters and the output parameters can be displayed more clearly, repeated work is reduced, frequent interface undefined communication is realized, the work efficiency is improved, time is used in more worthy work, and the cost is indirectly reduced. In specific implementation, an interface address can be input in a visual page, and then corresponding parameter information is searched according to the interface address, so as to generate interface documents under different scenes.

In the existing development practice, developers can reuse or change the existing interface to realize functions according to requirements, different scenes are different in participating and participating, an interface document structure which is clear at a glance can be generated after the interface is input, and the users can quickly enter the work without the help of other people. The interface structure document is similar to that shown in table one.

Table-interface structure document

In one embodiment, the method further comprises: acquiring a service updating request, wherein the service updating request carries updating data; and editing the class data in the source file according to the updating data, wherein the editing processing comprises at least one of adding data and deleting data to the class data.

Specifically, the server obtains the service update request, and can edit the class data in the source file according to the service update request. Specifically, the class data can be deleted, newly added, and the like.

In the above embodiment, the specific implementation of the function mainly depends on the annotation, and the dependency relationship between the input and output references can be declared by adding the "dependency" annotation, and the parameter information and the dependency relationship can be updated by deleting the annotation, so that the accuracy of the information in the annotation is always ensured, and the accuracy of the interface document automatically generated according to the annotation is ensured.

In the above embodiment, a scenario may be determined based on a parameter value (for example, beijing, so that the corresponding scenario is beijing scenario), and a scenario interface document may be generated according to the corresponding scenario. In addition, the above embodiments may also group the parameters, for example, all the parameters belonging to north China are grouped into one group, and then an interface document corresponding to each group may be generated. In the embodiment, different scenes can be distinguished again in each large group, for example, a Shandong scene and a Anhui scene are distinguished in a North China group, and the interface document is further refined, so that the obtained interface document is clearer and more readable in structure, and the efficiency of acquiring parameter information in the interface is improved.

It should be understood that although the various steps in the flow charts of fig. 2-4 are shown in order as indicated by the arrows, the steps are not necessarily performed in order as indicated by the arrows. The steps are not performed in the exact order shown and described, and may be performed in other orders, unless explicitly stated otherwise. Moreover, at least some of the steps in fig. 2-4 may include multiple steps or multiple stages, which are not necessarily performed at the same time, but may be performed at different times, which are not necessarily performed in sequence, but may be performed in turn or alternately with other steps or at least some of the other steps.

In one embodiment, as shown in fig. 5, there is provided an interface document generating apparatus based on parameter information, including:

the receiving module 502 is configured to receive a service request, where the service request carries an interface identifier.

The obtaining module 504 is configured to obtain a source file corresponding to the interface identifier, and obtain class data from the source file.

The searching module 506 is configured to search, based on the class data, parameter information corresponding to the interface identifier, where the parameter information includes interface parameters and a dependency relationship between the interface parameters, the interface parameters include interface input parameters and interface output parameters corresponding to the interface input parameters, and the dependency relationship includes at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters, and a dependency relationship between the interface input parameters and the interface output parameters.

And a first generating module 508, configured to generate an interface document corresponding to the interface according to the parameter information.

In one embodiment, the first generation module 508 includes:

and the first determining module is used for determining a parameter scene according to the parameter value corresponding to the interface input parameter.

And the second determining module is used for determining the scene input parameters corresponding to the parameter scene from the interface input parameters corresponding to the interface identification, and acquiring the scene output parameters and the scene dependency relationship corresponding to the scene input parameters from the interface output parameters and the dependency relationship corresponding to the interface identification.

And the second generation module is used for generating a scene interface document corresponding to the parameter scene according to the scene input parameters, the scene output parameters and the scene dependency relationship.

In an embodiment, when the number of the interface input parameters is more than one, the first generating module 508 is further configured to perform grouping processing on each interface input parameter to obtain multiple sets of interface input parameters; acquiring interface output parameters and a dependency relationship corresponding to the interface input parameters in each group, wherein the dependency relationship comprises at least one of the dependency relationship among the interface input parameters, the dependency relationship among the interface output parameters and the dependency relationship among the interface input parameters and the interface output parameters, and generating a group interface document corresponding to each group based on the interface input parameters, the interface output parameters and the dependency relationship in each group; and generating a plurality of groups of interface documents corresponding to the interface identifiers according to the grouping interface documents corresponding to each group.

In an embodiment, the first generating module 508 is further configured to obtain a parameter level corresponding to each interface input parameter; and grouping the interface input parameters according to the parameter levels to obtain multiple groups of interface input parameters.

In an embodiment, the first generating module 508 is further configured to obtain a parameter value corresponding to the interface input parameter in each group, and determine a grouping scenario corresponding to each group according to the parameter value; acquiring grouping scene input parameters corresponding to each grouping scene from the interface input parameters, acquiring grouping scene output parameters corresponding to the grouping scene input parameters and grouping scene dependency relations, wherein the grouping scene dependency relations comprise at least one of dependency relations among the grouping scene input parameters, dependency relations among the grouping scene output parameters and dependency relations among the grouping scene input parameters and the grouping scene output parameters, and generating grouping scene interface documents corresponding to the grouping scenes according to the grouping scene input parameters, the grouping scene output parameters and the grouping scene dependency relations; and generating a grouping interface document corresponding to each grouping according to the grouping scene interface document corresponding to each grouping scene, and storing the grouping interface document in the nodes in the block chain.

In one embodiment, the apparatus further includes an update module, where the update module is configured to obtain a service update request, and the service update request carries update data; and editing the class data in the source file according to the updating data, wherein the editing processing comprises at least one of adding data and deleting data to the class data.

For the specific definition of the interface document generation apparatus based on the parameter information, reference may be made to the above definition of the interface document generation method based on the parameter information, and details are not repeated here. The modules in the interface document generation device based on parameter information may be wholly or partially implemented by software, hardware and a combination thereof. The modules can be embedded in a hardware form or independent from a processor in the computer device, and can also be stored in a memory in the computer device in a software form, so that the processor can call and execute operations corresponding to the modules.

In one embodiment, a computer device is provided, which may be a server or a terminal, and its internal structure diagram may be as shown in fig. 6. The computer device includes a processor, a memory, and a network interface connected by a system bus. Wherein the processor of the computer device is configured to provide computing and control capabilities. The memory of the computer device comprises a storage medium and an internal memory. The storage medium stores an operating system, a computer program, and a database. The internal memory provides an environment for the operating system and computer programs in the storage medium to run. The database of the computer device is used for storing interface document generation data. The network interface of the computer device is used for communicating with an external terminal through a network connection. The computer program is executed by a processor to implement a method of interface document generation based on parameter information.

Those skilled in the art will appreciate that the architecture shown in fig. 6 is a block diagram of only a portion of the architecture associated with the subject application, and is not intended to limit the computing device to which the subject application may be applied, and that a computing device may in particular include more or less components than those shown, or combine certain components, or have a different arrangement of components.

In one embodiment, a computer device is provided, comprising a memory and a processor, the memory having a computer program stored therein, the processor implementing the following steps when executing the computer program: receiving a service request, wherein the service request carries an interface identifier; acquiring a source file corresponding to the interface identifier, and acquiring class data from the source file; based on the class data, searching parameter information corresponding to the interface identifier, wherein the parameter information comprises interface parameters and a dependency relationship between the interface parameters, the interface parameters comprise interface input parameters and interface output parameters corresponding to the interface input parameters, and the dependency relationship comprises at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters and a dependency relationship between the interface input parameters and the interface output parameters; and generating an interface document corresponding to the interface according to the parameter information.

In one embodiment, the processor, when executing the computer program, further performs the step of generating an interface document corresponding to the interface according to the parameter information, to: determining a parameter scene according to a parameter value corresponding to an interface input parameter; determining scene input parameters corresponding to the parameter scene from the interface input parameters corresponding to the interface identification, and acquiring scene output parameters and scene dependency relations corresponding to the scene input parameters from the interface output parameters and dependency relations corresponding to the interface identification; and generating a scene interface document corresponding to the parameter scene according to the scene input parameters, the scene output parameters and the scene dependency relationship.

In one embodiment, when the number of the interface input parameters is more than one, the processor when executing the computer program further performs the step of generating an interface document corresponding to the interface according to the parameter information: grouping each interface input parameter to obtain a plurality of groups of interface input parameters; acquiring interface output parameters and a dependency relationship corresponding to the interface input parameters in each group, wherein the dependency relationship comprises at least one of the dependency relationship among the interface input parameters, the dependency relationship among the interface output parameters and the dependency relationship among the interface input parameters and the interface output parameters, and generating a group interface document corresponding to each group based on the interface input parameters, the interface output parameters and the dependency relationship in each group; and generating a plurality of groups of interface documents corresponding to the interface identifiers according to the grouping interface documents corresponding to each group.

In one embodiment, the step of grouping the input parameters of each interface to obtain a plurality of sets of input parameters is further performed when the processor executes the computer program: acquiring the parameter level corresponding to each interface input parameter; and grouping the interface input parameters according to the parameter levels to obtain multiple groups of interface input parameters.

In one embodiment, the processor, when executing the computer program, obtains the interface output parameters and the dependency corresponding to the interface input parameters in each packet, where the dependency includes at least one of a dependency between the interface input parameters, a dependency between the interface output parameters, and a dependency between the interface input parameters and the interface output parameters, and the step of generating the packet interface document corresponding to the packet is further configured to: acquiring a parameter value corresponding to an interface input parameter in each group, and determining a grouping scene corresponding to each group according to the parameter value; acquiring grouping scene input parameters corresponding to each grouping scene from the interface input parameters, acquiring grouping scene output parameters corresponding to the grouping scene input parameters and grouping scene dependency relations, wherein the grouping scene dependency relations comprise at least one of dependency relations among the grouping scene input parameters, dependency relations among the grouping scene output parameters and dependency relations among the grouping scene input parameters and the grouping scene output parameters, and generating grouping scene interface documents corresponding to the grouping scenes according to the grouping scene input parameters, the grouping scene output parameters and the grouping scene dependency relations; and generating a grouping interface document corresponding to each grouping according to the grouping scene interface document corresponding to each grouping scene, and storing the grouping interface document in the nodes in the block chain.

In one embodiment, the computer program when executed by the processor is further operable to: acquiring a service updating request, wherein the service updating request carries updating data; and editing the class data in the source file according to the updating data, wherein the editing processing comprises at least one of adding data and deleting data to the class data.

In one embodiment, a computer-readable storage medium is provided, having a computer program stored thereon, which when executed by a processor, performs the steps of: receiving a service request, wherein the service request carries an interface identifier; acquiring a source file corresponding to the interface identifier, and acquiring class data from the source file; based on the class data, searching parameter information corresponding to the interface identifier, wherein the parameter information comprises interface parameters and a dependency relationship between the interface parameters, the interface parameters comprise interface input parameters and interface output parameters corresponding to the interface input parameters, and the dependency relationship comprises at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters and a dependency relationship between the interface input parameters and the interface output parameters; and generating an interface document corresponding to the interface according to the parameter information.

In one embodiment, the computer program when executed by the processor further performs the step of generating an interface document corresponding to the interface according to the parameter information, further: determining a parameter scene according to a parameter value corresponding to an interface input parameter; determining scene input parameters corresponding to the parameter scene from the interface input parameters corresponding to the interface identification, and acquiring scene output parameters and scene dependency relations corresponding to the scene input parameters from the interface output parameters and dependency relations corresponding to the interface identification; and generating a scene interface document corresponding to the parameter scene according to the scene input parameters, the scene output parameters and the scene dependency relationship.

In one embodiment, when the number of the interface input parameters is more than one, the computer program when executed by the processor further performs the step of generating an interface document corresponding to the interface according to the parameter information: grouping each interface input parameter to obtain a plurality of groups of interface input parameters; acquiring interface output parameters and a dependency relationship corresponding to the interface input parameters in each group, wherein the dependency relationship comprises at least one of the dependency relationship among the interface input parameters, the dependency relationship among the interface output parameters and the dependency relationship among the interface input parameters and the interface output parameters, and generating a group interface document corresponding to each group based on the interface input parameters, the interface output parameters and the dependency relationship in each group; and generating a plurality of groups of interface documents corresponding to the interface identifiers according to the grouping interface documents corresponding to each group.

In one embodiment, the computer program when executed by the processor performs the step of grouping the input parameters of each interface to obtain a plurality of sets of input parameters is further configured to: acquiring the parameter level corresponding to each interface input parameter; and grouping the interface input parameters according to the parameter levels to obtain multiple groups of interface input parameters.

In one embodiment, the computer program, when executed by the processor, is further configured to obtain an interface output parameter and a dependency relationship corresponding to the interface input parameter in each packet, where the dependency relationship includes at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters, and a dependency relationship between the interface input parameters and the interface output parameters, and the step of generating a packet interface document corresponding to the packet based on the interface input parameters, the interface output parameters, and the dependency relationship in each packet is further configured to: acquiring a parameter value corresponding to an interface input parameter in each group, and determining a grouping scene corresponding to each group according to the parameter value; acquiring grouping scene input parameters corresponding to each grouping scene from the interface input parameters, acquiring grouping scene output parameters corresponding to the grouping scene input parameters and grouping scene dependency relations, wherein the grouping scene dependency relations comprise at least one of dependency relations among the grouping scene input parameters, dependency relations among the grouping scene output parameters and dependency relations among the grouping scene input parameters and the grouping scene output parameters, and generating grouping scene interface documents corresponding to the grouping scenes according to the grouping scene input parameters, the grouping scene output parameters and the grouping scene dependency relations; and generating a grouping interface document corresponding to each grouping according to the grouping scene interface document corresponding to each grouping scene, and storing the grouping interface document in the nodes in the block chain.

The block chain is a novel application mode of computer technologies such as distributed data storage, point-to-point transmission, a consensus mechanism, an encryption algorithm and the like. A block chain (Blockchain), which is essentially a decentralized database, is a series of data blocks associated by using a cryptographic method, and each data block contains information of a batch of network transactions, so as to verify the validity (anti-counterfeiting) of the information and generate a next block. The blockchain may include a blockchain underlying platform, a platform product service layer, an application service layer, and the like.

It will be understood by those skilled in the art that all or part of the processes in the methods of the embodiments described above may be implemented by hardware related to instructions of a computer program, and the computer program may be stored in a computer-readable storage medium, which may be volatile or non-volatile. The computer program, when executed, may comprise the flows of embodiments of the methods described above. Any reference to memory, storage, database or other medium used in the embodiments provided herein can include at least one of non-volatile and volatile memory. Non-volatile Memory may include Read-Only Memory (ROM), magnetic tape, floppy disk, flash Memory, optical storage, or the like. Volatile Memory can include Random Access Memory (RAM) or external cache Memory. By way of illustration and not limitation, RAM can take many forms, such as Static Random Access Memory (SRAM) or Dynamic Random Access Memory (DRAM), among others.

The technical features of the above embodiments can be arbitrarily combined, and for the sake of brevity, all possible combinations of the technical features in the above embodiments are not described, but should be considered as the scope of the present specification as long as there is no contradiction between the combinations of the technical features.

The above examples only express several embodiments of the present application, and the description thereof is more specific and detailed, but not construed as limiting the scope of the invention. It should be noted that, for a person skilled in the art, several variations and modifications can be made without departing from the concept of the present application, which falls within the scope of protection of the present application. Therefore, the protection scope of the present patent shall be subject to the appended claims.

Claims

1. A method for generating an interface document based on parameter information is characterized by comprising the following steps:

2. The method according to claim 1, wherein the generating an interface document corresponding to an interface according to the parameter information includes:

determining a parameter scene according to the parameter value corresponding to the interface input parameter;

3. The method according to claim 1, wherein when the number of the interface input parameters is more than one, the generating an interface document corresponding to the interface according to the parameter information includes:

grouping the interface input parameters to obtain a plurality of groups of interface input parameters;

acquiring interface output parameters and a dependency relationship corresponding to the interface input parameters in each group, wherein the dependency relationship comprises at least one of a dependency relationship among the interface input parameters, a dependency relationship among the interface output parameters and a dependency relationship among the interface input parameters and the interface output parameters, and generating a group interface document corresponding to the group based on the interface input parameters, the interface output parameters and the dependency relationship in each group;

and generating a plurality of groups of interface documents corresponding to the interface identification according to the grouping interface documents corresponding to each group.

4. The method of claim 3, wherein grouping each of the interface input parameters to obtain a plurality of sets of input parameters comprises:

acquiring the parameter level corresponding to each interface input parameter;

5. The method according to claim 3, wherein the obtaining interface output parameters and dependency relationships corresponding to the interface input parameters in each group, the dependency relationships including at least one of dependency relationships between the interface input parameters, dependency relationships between the interface output parameters, and dependency relationships between the interface input parameters and the interface output parameters, and generating a group interface document corresponding to each group based on the interface input parameters, the interface output parameters, and the dependency relationships in each group comprises:

acquiring a parameter value corresponding to the interface input parameter in each group, and determining a grouping scene corresponding to each group according to the parameter value;

acquiring a grouping scene input parameter corresponding to each grouping scene from the interface input parameters, acquiring a grouping scene output parameter corresponding to the grouping scene input parameter and a grouping scene dependency relationship, wherein the grouping scene dependency relationship comprises at least one of a dependency relationship among the grouping scene input parameters, a dependency relationship among the grouping scene output parameters and a dependency relationship among the grouping scene input parameters and the grouping scene output parameters, and generating a grouping scene interface document corresponding to the grouping scene according to the grouping scene input parameter, the grouping scene output parameter and the grouping scene dependency relationship;

and generating a grouping interface document corresponding to each grouping according to the grouping scene interface document corresponding to each grouping scene, and storing the grouping interface document in the nodes in the block chain.

6. The method according to any one of claims 1 to 5, further comprising:

and editing the class data in the source file according to the updating data, wherein the editing comprises at least one of adding data and deleting data to the class data.

7. An interface document generation apparatus based on parameter information, the apparatus comprising:

a receiving module, configured to receive a service request, where the service request carries an interface identifier;

a searching module, configured to search, based on the class data, parameter information corresponding to the interface identifier, where the parameter information includes interface parameters and a dependency relationship between the interface parameters, where the interface parameters include interface input parameters and interface output parameters corresponding to the interface input parameters, and the dependency relationship includes at least one of a dependency relationship between the interface input parameters, a dependency relationship between the interface output parameters, and a dependency relationship between the interface input parameters and the interface output parameters;

8. The apparatus of claim 7, wherein the first generating module comprises:

the first determining module is used for determining a parameter scene according to the parameter value corresponding to the interface input parameter;

a second determining module, configured to determine a scene input parameter corresponding to the parameter scene from the interface input parameters corresponding to the interface identifier, and obtain a scene output parameter and a scene dependency corresponding to the scene input parameter from the interface output parameter and the dependency corresponding to the interface identifier;

9. A computer device comprising a memory and a processor, the memory storing a computer program, characterized in that the processor, when executing the computer program, implements the steps of the method of any of claims 1 to 6.

10. A computer-readable storage medium, on which a computer program is stored, which, when being executed by a processor, carries out the steps of the method of any one of claims 1 to 6.