CN113590097B

CN113590097B - API interface generation method and device, electronic equipment and storage medium

Info

Publication number: CN113590097B
Application number: CN202110875134.8A
Authority: CN
Inventors: 胡肖宇; 金可栋; 杨华; 谷皓; 那瑞冬; 管洪昌; 孙晨阳
Original assignee: Zhongdian Jinxin Software Co Ltd
Current assignee: Zhongdian Jinxin Software Co Ltd
Priority date: 2021-07-30
Filing date: 2021-07-30
Publication date: 2022-11-29
Anticipated expiration: 2041-07-30
Also published as: CN113590097A

Abstract

The application provides a method and a device for generating an API (application program interface), electronic equipment and a storage medium, wherein the generation method comprises the following steps: acquiring interface requirements; judging whether an API interface corresponding to the acquired interface requirement exists or not based on a pre-stored mapping relation library of the interface requirement and the API interface; if the API interface corresponding to the acquired interface requirement does not exist, determining a configuration requirement for constructing the API interface based on the acquired interface requirement; determining components and component connection relations required for constructing the API interface based on the configuration requirements; configuring the components required by the API interface according to the component connection relation from a pre-stored component template library; and generating configuration data according to the configured components, and generating an API (application program interface) corresponding to the interface requirement based on the configuration data. According to the generation method and the generation device, the use and the management of the API are more convenient.

Description

API interface generation method and device, electronic equipment and storage medium

Technical Field

The present application relates to the field of computer technologies, and in particular, to a method and an apparatus for generating an API interface, an electronic device, and a storage medium.

Background

With the continuous abundance of data resources, the market demand for data interaction is gradually increased, and in order to ensure the accuracy and security of data, the external interaction of the system mainly provides externally required data through an external API interface. Therefore, API development has become one of the hot spots in the field of software development at present.

The conventional generation method of the API interface usually needs technical personnel with a certain technical background to develop a large amount of codes according to the interface requirement corresponding to each service, so that the time required for developing the API interface is long, and the development efficiency of the API interface is low. And when the service is changed, the interface is required to be correspondingly modified, and frequent secondary development not only increases the development workload, but also destroys the stability of the interface, and brings inconvenience to the use of the interface.

Disclosure of Invention

In view of this, an object of the present application is to provide a method and an apparatus for generating an API interface, which can effectively shorten the time required for developing the API interface and improve the development efficiency of the API interface.

In a first aspect, an embodiment of the present application provides a method for generating an API interface, where the method for generating an API interface includes:

acquiring interface requirements;

judging whether an API interface corresponding to the acquired interface requirement exists or not based on a pre-stored mapping relation library of the interface requirement and the API interface;

if the API interface corresponding to the acquired interface requirement does not exist, determining a configuration requirement for constructing the API interface based on the acquired interface requirement;

determining components and component connection relations required for constructing the API interface based on the configuration requirements;

configuring the components required by the API interface according to the component connection relation from a pre-stored component template library;

and generating configuration data according to the configured components, and generating an API (application program interface) corresponding to the interface requirement based on the configuration data.

Further, the generating method further includes:

and storing the interface requirement and the API interface corresponding to the interface requirement into the mapping relation library in a mapping relation.

Further, the generating method further includes:

if an API interface corresponding to the acquired interface requirement exists, calling the API interface to perform data interaction;

if the data acquired by calling the API does not conform to the acquired interface requirement, modifying the configuration data of the API corresponding to the acquired interface requirement according to the acquired interface requirement, and generating the API according to the modified configuration data;

and storing the acquired interface requirements and the API interface generated according to the modified configuration data into the mapping relation library in a mapping relation.

Further, the configuring requirement includes a data table and data attributes in the data table, and the configuring, from a pre-stored component template library, the components required by the API interface according to the component connection relationship includes:

selecting a component template required by the API interface from a pre-stored component template library;

displaying the component configuration parameters of the selected component template, and editing the data table of the component configuration parameters and the data attributes in the data table;

generating a component in response to determining the component configuration parameters;

and dragging the generated component to a position corresponding to the component connection relation.

Further, the generating of configuration data according to the configured component and the generating of the API interface corresponding to the interface requirement based on the configuration data include;

performing interface calling test on each component in the configuration data to obtain a test result;

if the test result is not different from the interface requirement, executing a step of generating an API interface corresponding to the interface requirement based on the configuration data;

and if the test result is different from the interface requirement, re-editing the component until the test result obtained by the component corresponds to the interface requirement of the API interface, and executing a step of generating the API interface corresponding to the interface requirement based on the configuration data.

Further, the generating method further includes:

receiving an interface updating requirement;

acquiring an API interface to be updated mapped by the interface updating requirement from the mapping relation library;

acquiring a component corresponding to the API interface to be updated and a component connection relation;

updating the acquired component and the component connection relation according to the interface updating requirement, and generating an API (application programming interface) corresponding to the interface updating requirement based on the updated component and the component connection relation;

if the interface updating requirement is to add or delete the component corresponding to the API interface to be updated, storing the interface updating requirement and the API interface corresponding to the interface updating requirement into the mapping relation library in a mapping relation;

and if the interface updating requirement includes the modification of the component corresponding to the API interface to be updated, replacing the API interface which is correspondingly stored in the mapping relation library by using the API interface corresponding to the interface updating requirement.

In a second aspect, an embodiment of the present application further provides a device for generating an API interface, where the device includes:

the acquisition module is used for acquiring interface requirements;

the judging module is used for judging whether an API interface corresponding to the acquired interface requirement exists or not based on a mapping relation library of the prestored interface requirement and the API interface;

the first determining module is used for determining the configuration requirement for constructing the API interface based on the acquired interface requirement if the API interface corresponding to the acquired interface requirement does not exist;

the second determining module is used for determining components and component connection relations required by the API interface construction based on the configuration requirements;

the configuration module is used for configuring the components required by the API interface according to the component connection relation from a pre-stored component template library;

and the generating module is used for generating configuration data according to the configured components and generating the API interface corresponding to the interface requirement based on the configuration data.

Further, the generating device further includes:

and the storage module is used for storing the interface requirement and the API interface corresponding to the interface requirement into the mapping relation library in a mapping relation.

In a third aspect, an embodiment of the present application further provides an electronic device, including: a processor, a memory and a bus, the memory storing machine-readable instructions executable by the processor, the processor and the memory communicating via the bus when the electronic device is running, the machine-readable instructions being executed by the processor to perform the steps of the API interface generation method as described above.

Embodiments of the present application further provide a computer-readable storage medium, on which a computer program is stored, where the computer program is executed by a processor to perform the steps of the method for generating an API interface.

According to the method for generating the API interface, firstly, interface requirements are obtained; then, judging whether an API interface corresponding to the acquired interface requirement exists or not based on a pre-stored mapping relation library of the interface requirement and the API interface; if the API interface corresponding to the acquired interface requirement does not exist, determining a configuration requirement for constructing the API interface based on the acquired interface requirement; determining components and component connection relations required for constructing the API interface based on the configuration requirements; configuring the components required by the API interface according to the component connection relation from a pre-stored component template library; and finally, generating configuration data according to the configured components, and generating an API (application programming interface) corresponding to the interface requirement based on the configuration data.

Compared with the generation method of the API interface in the prior art, the generation method of the API interface provided in the embodiment of the present application may determine whether the API interface corresponding to the acquired interface requirement exists based on a mapping relationship library of the interface requirement and the API interface stored in advance, determine a configuration requirement for constructing the API interface if the API interface does not exist, configure a component required by the API interface according to the configuration requirement, generate configuration data, and generate the API interface that can meet the interface requirement after the configuration data passes an interface call test. If yes, judging whether the API interface meets the interface requirement, and if not, upgrading the API interface. According to the API interface generation method, when the API interface is generated, the components required by the API interface are directly configured from the pre-stored component template library, and the configuration data are generated by dragging the components to generate the API interface, so that the code development steps required by the API interface generation can be reduced, the API interface can be generated more conveniently and rapidly, and the development cycle of a new API interface is greatly shortened. The method can also be used for directly modifying the existing API interface to generate a new API interface, thereby avoiding secondary development of the API interface, ensuring the stability of the existing API interface and enabling the use and management of the API interface to be more convenient.

In order to make the aforementioned objects, features and advantages of the present application more comprehensible, preferred embodiments accompanied with figures are described in detail below.

Drawings

In order to more clearly illustrate the technical solutions of the embodiments of the present application, the drawings that are required to be used in the embodiments will be briefly described below, it should be understood that the following drawings only illustrate some embodiments of the present application and therefore should not be considered as limiting the scope, and for those skilled in the art, other related drawings can be obtained from the drawings without inventive effort.

Fig. 1 is a flowchart of a method for generating an API interface according to an embodiment of the present disclosure;

FIG. 2A is a schematic diagram of a component management interface provided by an embodiment of the present application;

FIG. 2B is a schematic diagram of a component management interface according to another embodiment of the present application;

FIG. 3 is a flow chart of generating an API interface according to modified configuration data as provided by an embodiment of the present application;

fig. 4 is a schematic structural diagram of an apparatus for generating an API interface according to an embodiment of the present disclosure;

fig. 5 is a second schematic structural diagram of an apparatus for generating an API interface according to an embodiment of the present disclosure;

fig. 6 is a schematic structural diagram of an electronic device according to an embodiment of the present application.

Detailed Description

In order to make the objects, technical solutions and advantages of the embodiments of the present application clearer, the technical solutions in the embodiments of the present application will be clearly and completely described below with reference to the drawings in the embodiments of the present application, and it is obvious that the described embodiments are only a part of the embodiments of the present application, and not all the embodiments. The components of the embodiments of the present application, generally described and illustrated in the figures herein, can be arranged and designed in a wide variety of different configurations. Thus, the following detailed description of the embodiments of the present application, presented in the accompanying drawings, is not intended to limit the scope of the claimed application, but is merely representative of selected embodiments of the application. Every other embodiment that can be obtained by a person skilled in the art without making creative efforts based on the embodiments of the present application falls within the protection scope of the present application.

The conventional method for generating the API interface usually needs development of a large amount of codes, requires a technical background of technicians, and is slow in interface creation speed. Meanwhile, for a complex flow, a large number of codes need to be written, and the service extensible requirement also needs to be met. When the service is changed, the interface is also required to be correspondingly modified, and frequent secondary development not only increases the development workload, but also destroys the stability of the interface, and brings inconvenience to the use of the interface.

Based on this, the embodiment of the present application provides a method for generating an API interface, so as to solve the technical problem that the speed is slow when the API interface is generated in the prior art.

Referring to fig. 1, fig. 1 is a flowchart illustrating a method for generating an API interface according to an embodiment of the present disclosure. As shown in fig. 1, a method for generating an API interface provided in an embodiment of the present application includes:

and S101, acquiring interface requirements.

It should be noted that the interface requirement refers to a requirement that the user wants to obtain which data through the interface, and as an alternative implementation, the interface requirement may be a requirement that the user puts forward for data in the database.

Specifically, the interface requirement may be an interface requirement set by a user based on an API interface. Here, an API (Application Programming Interface) Interface refers to some predefined Interface (e.g., function, HTTP Interface), or to a convention for interfacing different components of a software system, and is used to provide a set of routines that an Application and a developer can access based on certain software or hardware, without accessing source code or understanding details of internal working mechanisms. With the help of the API interface, various resources in the computer system can be quickly, effectively, safely and reliably operated to process the own program interface.

For the step S101, in a specific implementation, the interface requirement of the API interface may be input externally, or may be generated by a developer operating directly on a terminal (platform), and the terminal responds to the operation of the developer to obtain the interface requirement of the API interface. When the interface requirement of the external service is acquired, the information can be acquired in various information acquisition modes (such as receiving mails, QQ, weChat, short messages and the like). For example, if the external service requirement end needs to obtain data of the information related to the client table, an API interface capable of querying the data information of the client table needs to be provided by the service end, and at this time, the external service interface requirement sent from the external service requirement end to the service end includes information such as a client name, a gender, an identification number, a mobile phone number, and the like.

And S102, judging whether an API interface corresponding to the acquired interface requirement exists or not based on a mapping relation library of the prestored interface requirement and the API interface.

It should be noted that the mapping relation library refers to a database for storing mapping relations between objects, and corresponds to a database for representing information in the form of objects. Mapping relationships generally refer to object relational mapping, which is the transformation between data used to implement different types of systems in an object-oriented programming language. According to the embodiment provided by the application, the existing interface requirements and the existing API interfaces corresponding to the interface requirements can be stored in the mapping relation library, and one interface requirement corresponds to one API interface capable of realizing the interface requirements.

As an optional implementation manner, when determining whether there is an API interface corresponding to the acquired interface requirement, the determination is performed by a method of calculating semantic similarity or text similarity. After the interface requirements sent by the user are obtained, semantic similarity calculation or text similarity calculation is carried out on the obtained interface requirements and each stored existing interface requirement. If the calculated semantic similarity or text similarity is larger than a preset similarity threshold, determining that an API interface corresponding to the acquired interface requirement exists, otherwise, if the calculated semantic similarity or text similarity is smaller than the preset similarity threshold, determining that the API interface corresponding to the acquired interface requirement does not exist. The technology how to calculate semantic similarity or text similarity between two documents is described in detail in the prior art, and will not be described herein too much.

Here, it should be noted that the above-described example of how to determine whether or not the API interface corresponding to the acquired interface requirement exists is merely an example, and in practice, the method of how to determine whether or not the API interface corresponding to the acquired interface requirement exists is not limited to the above-described example.

As an optional implementation manner, when there is no API interface corresponding to the interface requirement, an API interface corresponding to the interface requirement needs to be generated to implement the interface requirement, and then step S103 is executed.

S103, if the API interface corresponding to the acquired interface requirement does not exist, determining a configuration requirement for constructing the API interface based on the acquired interface requirement.

It should be noted that the configuration requirement refers to a configuration requirement determined for the acquired interface requirement to construct the API interface. Continuing with the previous embodiment, the obtained interface requirement is an API interface that can query data information of the client table, and at this time, the configuration requirement determined according to the interface requirement for constructing the API interface may be a client table and some data attributes in the client table. Here, when it is determined that there is no API interface corresponding to the interface requirement, a configuration requirement corresponding to the API interface is generated according to the interface requirement, and the API interface corresponding to the interface requirement is generated based on the configuration requirement.

Here, it should be noted that the above examples of the configuration requirements for constructing the API interface are merely examples, and in practice, the configuration requirements for constructing the API interface are not limited to the above examples.

For step S103, the configuration requirement required by the API interface is determined based on the interface requirement acquired in step S101. As an optional implementation manner, the acquired interface requirements may be analyzed manually to obtain configuration requirements required by the API interface.

And S104, determining components and component connection relations required for constructing the API interface based on the configuration requirements.

It should be noted that a component refers to a component for building configuration data corresponding to an API interface. The component connection relationship is used to represent the connection relationship between different components, and specifically, the connection relationship may be represented in the form of a connection line between each component, and the connection line may also be drawn between each component by a user, and the connection line between the components facilitates the implementation of the flow of the business process corresponding to the API interface. As an alternative embodiment, the components may be pre-stored in a component template library of the component management interface, and the components required for constructing the API interface are determined based on configuration requirements. Components include, but are not limited to, start class components, including flow start components, and the like; the data access assembly comprises a data access assembly, a third party interface assembly, a sub-process assembly and the like; the data processing component comprises a program processing component, an SQL-UNION component, a judgment component and the like; and the ending component comprises a flow ending component and the like. Continuing with the previous embodiment, when the configuration requirement is four data attributes of the client table and the client name, the gender, the identification number and the mobile phone number in the client table, it is determined according to the configuration requirement that the desired interface is an interface capable of retrieving data in the data table and the data table, and therefore it can be determined that the components required for constructing the API interface may include a process start component, a data access component and a process end component. The connection relation of the components can also be determined according to the determined components, the flow starting component is connected with the data access component, and the flow access component is connected with the flow ending component.

And S105, configuring the components required by the API interface according to the component connection relation from a pre-stored component template library.

It should be noted that the component template library refers to a database for storing various components. In specific implementation, the corresponding component needs to be selected from the component module library according to the determined component connection relationship in step S104 to configure the component required by the API interface.

As an optional implementation, the configuration requirement includes a data table and a data attribute in the data table. The configuring the components required by the API interface according to the component connection relation from a pre-stored component template library comprises:

step 1051, selecting a component template required by the API interface from a pre-stored component template library.

The component template refers to a template stored in advance in a component template library, and a user selects a required component template from the component template library based on a determined configuration requirement. Continuing the previous embodiment, when the determined components required for constructing the API interface may include a flow starting component, a data accessing component and a flow ending component, selecting component templates corresponding to the flow starting component, the data accessing component and the flow ending component from a pre-stored component module library.

Step 1052, showing the component configuration parameters of the selected component template, and editing the data table of the component configuration parameters and the data attributes in the data table.

It should be noted that the component configuration parameters refer to configuration parameters that are input by a user in the component module and are used for generating a corresponding component. The determined component configuration parameter may be at least one of a name of a data table corresponding to the interface requirement and a field corresponding to a data attribute in the data table. The name of the data table may be the name of an existing data table such as a client table or a user table. The fields corresponding to the data attributes in the data table may be data attributes in an existing data table such as name, gender, etc. After the configuration requirement of the API interface is determined, the required components are determined according to the configuration requirement, and a component template required by the API interface is selected from a pre-stored component template library. And after the component template is determined, editing the data table for establishing the configuration parameters and the data attributes in the data table from the component editing frame of the displayed component template.

In step 1052, in a specific implementation, according to a component template required by the API interface selected in the component template library, the component configuration parameters edited by the user in the component template are obtained. For example, fig. 2A is a schematic diagram of a component management interface provided in an embodiment of the present application, and as shown in fig. 2A, the component template library is used to store preset component templates, and is used to respond to selection operations of component templates required by the API interface to obtain types of different component templates selected by a user. The component editing frame is used for displaying the component configuration parameters of the selected component template, responding to the editing operation of the component configuration parameters, and editing the data table of the component configuration parameters and the data attributes in the data table. A user selects a required component template from the component templates shown in fig. 2A, responds to a selection operation of the user on the component template, displays the component configuration parameters of the selected component template, and edits the data table of the component configuration parameters and the data attributes in the data table. For example, in the embodiment provided in fig. 2A, a user selects a component template, such as a data access component, from a component template library, then presents component configuration information of the component template in a component edit box, and edits data tables of component configuration parameters of the component and data attributes in the data tables. The name of the component may be edited in a component edit box, for example, named "data access component". The data acquisition mode may also be edited, a column of "acquisition mode" may correspond to the name of the data table that needs to be input, such as "customer table", and a column of "parameter" may correspond to the field in the data table that needs to be input, such as "customer name".

Here, it should be noted that the above examples of the component configuration parameters are only examples, and in practice, the component configuration parameters are not limited to the above examples, and when the obtained interface requirements are different, the corresponding configuration requirements may also be changed along with the interface requirements, and further, the component configuration parameters may also be changed along with the change of the configuration requirements.

Step 1053, generating the component in response to the determination of the component configuration parameters.

Continuing with the previous embodiment, there are two buttons in the component edit box of FIG. 2A, one for "reset" and one for "save". After the component configuration parameters are input, the user may click on the "save" button, and then, in response to the determination of the component configuration parameters by the user, the corresponding component is generated based on the component configuration parameters edited in step 1052. After the component is generated, the user can click a reset button to reset the component configuration parameters input above and input new component configuration parameters for the next component.

And 1054, dragging the generated component to a position corresponding to the component connection relation.

The dragging refers to an operation of dragging a component required for configuring the API interface when the user constructs the API interface. During specific implementation, a user can directly construct the API interface in a component dragging mode, the generated component is dragged to a position corresponding to the component connection relation, code development steps required for generating the API interface can be reduced, the API interface is generated more conveniently and rapidly, and the development period of a new API interface is greatly shortened.

And S106, generating configuration data according to the configured components, and generating an API (application programming interface) corresponding to the interface requirement based on the configuration data.

According to the embodiment provided by the application, the configuration data can be generated according to the dragging operation of the component by the user when the configuration data is generated. And after the components required by the API interface are configured, generating corresponding configuration data according to the configured components. For example, fig. 2B is a schematic diagram of a component management interface according to another embodiment of the present application, and as shown in fig. 2B, a component display frame is used to display configuration data, when a component management device detects a drag instruction of a component, the dragged component is determined as a target component, and position information of the target component in the component display frame in fig. 2B is obtained in real time. When the component management apparatus detects a release instruction of the target component, the position information of the target component is determined as a final position of the target component. The above operations are repeated until all the components are added to the interface, configuration data is formed, display is performed in the component display frame in fig. 2B, and the component connection relationship of each component is recorded. In the embodiment, when the API interface is generated, the components required by the API interface are directly configured from the pre-stored component template library, and the configuration data is generated by dragging the components to generate the API interface, so that the code development steps required by the generation of the API interface can be reduced, the API interface can be generated more conveniently and rapidly, and the development period of a new API interface is greatly shortened.

In the embodiment provided by the application, after the components are placed in the component display frame, the connection between the components can be automatically generated, the connection can also be drawn between the components by the user, and the connection between the components is convenient for realizing the circulation of the business process corresponding to the API interface.

After the configuration data of the API interface is configured, interface testing needs to be performed on each component in the configuration data, and the finally obtained API interface can meet the interface requirements. As an optional implementation manner, the generating configuration data according to the configured component and generating an API interface corresponding to the interface requirement based on the configuration data includes;

step 1061, performing an interface call test on each component in the configuration data to obtain a test result.

It should be noted that the interface call test refers to a test for testing an interface between system components, and the test is mainly to check the exchange, transmission, and control management processes of data, mutual logic dependencies between systems, and the like. The test result refers to a test result obtained by the interface call test, for example, a component is used to obtain a client table, and after the interface call test is performed on the component, data obtained by the component may be a test result.

Step 1062, if there is no difference between the test result and the interface requirement, executing a step of generating an API interface corresponding to the interface requirement based on the configuration data.

And 1063, if the test result is different from the interface requirement, re-editing the component until the test result obtained by the component corresponds to the interface requirement of the API interface, and performing a step of generating the API interface corresponding to the interface requirement based on the configuration data.

For the above steps 1061-1063, an interface call test is performed on each component in the configuration data to obtain a test result of the component. And comparing the obtained test result of the component with the interface requirement of the API interface, if the test result is not different from the interface requirement of the API interface, executing step 1062, and generating the API interface corresponding to the interface requirement based on the configuration data. If the test result is different from the interface requirement of the API interface, step 1063 is performed. For example, the interface requirement of the obtained API interface is to obtain a client name and a gender in a client table, after an interface call test is performed on each component, it is found that data obtained by one of the components is not the client name in the client table, but an identity number in the client table is obtained, it is considered that a test result is different from the interface requirement of the API interface, at this time, a component configuration parameter corresponding to the component needs to be modified, the corresponding component is edited again, an interface call test is performed after the modification until the test result obtained by each component in the configuration data corresponds to the interface requirement, at this time, it is considered that the configuration data can realize the interface requirement of the API interface, at this time, a step of generating the API interface corresponding to the interface requirement based on the configuration data is performed, and the API interface corresponding to the interface requirement is generated based on the determined configuration data.

As an optional implementation manner, after the API interface is generated, the method for generating the API interface provided in the embodiment of the present application further includes:

In specific implementation, after the API interface is generated, the API interface corresponding to the interface requirement and the generated interface requirement needs to be stored in the mapping relation library in a mapping relation, so that the corresponding API interface can be selected and called directly according to the interface requirement next time.

According to the method for generating the API interface, the code development steps required by API interface generation can be reduced, the problem that the API interface generation speed is low in the prior art is solved by configuring the components required by the API interface from the pre-stored component template library and generating the API interface corresponding to the interface requirement according to the configuration data, the component configuration parameters can be directly edited from the existing component template to generate the required components, the API interface generation speed is improved, the code development process is reduced, the API interface is generated more conveniently and rapidly, and the development cycle of a new API interface is greatly shortened. And the corresponding API interface is generated after the interface test is passed, so that the situation that the API interface is established wrongly can be avoided.

As an optional implementation manner, when there is an API interface corresponding to the interface requirement, step S201 is executed. If an API corresponding to the interface requirement exists, whether the data acquired by the API is the same as the interface requirement needs to be judged, and if the data acquired by the API is the same as the interface requirement, the API can be directly called to acquire the data. If the data acquired by the API interface is different from the interface requirement, the following steps are required to be executed, the existing API interface is upgraded, and the configuration data in the API interface can be directly modified to generate a modified API interface corresponding to the interface requirement. Referring to fig. 3, fig. 3 is a flowchart illustrating an API interface generating according to modified configuration data according to an embodiment of the present application. As shown in fig. 3, the generating method further includes:

s201, if an API interface corresponding to the acquired interface requirement exists, calling the API interface to perform data interaction.

For the step S201, when it is determined in the step S10 that the API interface corresponding to the acquired interface requirement exists, the API interface corresponding to the interface requirement is called to perform data interaction, so as to acquire the service data corresponding to the API interface.

S202, if the data acquired by calling the API does not accord with the acquired interface requirement, modifying the configuration data of the API corresponding to the acquired interface requirement according to the acquired interface requirement, and generating the API according to the modified configuration data.

As an optional implementation manner, when the data acquired by the API interface is different from the interface requirement, the API interface needs to be upgraded, and the configuration data in the API interface may be directly modified to generate a modified API interface corresponding to the interface requirement.

For step S202, in a specific implementation, components in the configuration data corresponding to the API interface may be added, deleted, or updated according to the acquired interface requirement to generate modified configuration data, perform an interface call test on the modified configuration data, and if a test result is the same as the interface requirement, generate an API interface corresponding to the interface requirement according to the modified configuration data.

For example, when the interface requirement of the obtained API interface is that the name, the gender, and the identification number of the client in the client table are needed, but the existing API interface can only obtain the name and the gender of the client in the client table, but cannot obtain the identification number of the client table, the data obtained by calling the API interface is considered not to meet the obtained interface requirement, the existing API interface needs to be upgraded, the configuration data of the API interface corresponding to the obtained interface requirement is modified according to the obtained interface requirement, and the API interface is generated according to the modified configuration data. Since the identification number in the client table is less obtained, a new component is required to obtain the identification number in the client table. The configuration data of the original API interface corresponding to the interface requirement is obtained, and the original configuration data is displayed in the component display frame in fig. 2A. Selecting a corresponding component template from the component template library in fig. 2A, editing component configuration parameters of the component template in a component editing frame in fig. 2A, filling a name of a data table, namely a client table, in an acquisition mode, and filling a data attribute, namely an identity card number, in the data table, in a parameter. And responding to the determined operation of the user on the component configuration parameters to generate a corresponding component, responding to the dragging operation of the user on the component, and displaying the component in a component display frame to generate modified configuration data. At this time, the interface call test is performed on the modified configuration data, and the manner of performing the interface call test is the same as the method of performing the interface call test in steps 1061 to 1064, which is not described herein again. And after the obtained test result is the same as the interface requirement, the modified API interface is considered to meet the interface requirement, and the modified API interface is generated according to the modified configuration data. When the interface requirement changes, the API interface can be modified in a mode of increasing or reducing the components, secondary development of the API interface is avoided, the stability of the existing API interface is ensured, and the API interface can be used and managed more conveniently.

S203, storing the acquired interface requirements and the API interface generated according to the modified configuration data into the mapping relation library in a mapping relation.

In specific implementation, after the API interface is generated according to the modified configuration data, the interface requirement and the API interface generated according to the modified configuration data need to be stored in the mapping relation library in a mapping relation, so that the corresponding API interface can be directly selected and called according to the interface requirement next time.

As an optional implementation, the generating method further includes:

and A, receiving an interface updating requirement.

It should be noted that the interface update requirement refers to a request for updating an existing API interface. For example, the interface update requirement may be "update the API interface for obtaining the name of the client in the client table to the API interface for obtaining the name of the client and the phone number of the client in the client table".

And B, acquiring the API interface to be updated mapped by the interface updating requirement from the mapping relation library.

Specifically, the method for obtaining the API interface to be updated mapped by the interface update requirement from the mapping relationship library according to the interface update requirement is also obtained by calculating semantic similarity or text similarity. After the interface updating requirement sent by the user is obtained, semantic similarity calculation or text similarity calculation is carried out on the obtained interface requirement and the stored interface requirement of each existing API, and the API corresponding to the interface requirement with the highest similarity is taken as the API to be updated mapped by the interface updating requirement. The technology how to calculate semantic similarity or text similarity between two documents is described in detail in the prior art, and will not be described herein too much.

And C, acquiring the component corresponding to the API interface to be updated and the component connection relation.

For the above steps, after the to-be-updated API mapped by the interface update requirement is obtained, since the to-be-updated API is an interface already constructed by the component, the component and the component connection relationship used when the update API is constructed are obtained, and the component connection relationship corresponding to the to-be-updated API are displayed in the component display frame in fig. 2B.

And D, updating the acquired component and the component connection relation according to the interface updating requirement, and generating an API (application program interface) corresponding to the interface updating requirement based on the updated component and the component connection relation.

And E, if the interface updating requirement is to add or delete the component corresponding to the API interface to be updated, storing the interface updating requirement and the API interface corresponding to the interface updating requirement into the mapping relation library in a mapping relation.

And F, if the interface updating requirement includes the modification of the component corresponding to the API interface to be updated, replacing the API interface correspondingly stored in the mapping relation library by using the API interface corresponding to the interface updating requirement.

And aiming at the three steps, updating the acquired components and the component connection relation according to the interface updating requirement. For example, the acquired interface update requirement is "update the API interface for acquiring the client name in the client table to the API interface for acquiring the client name and the client telephone in the client table", it is considered that a component capable of acquiring the client telephone in the client table needs to be added to update the existing component and component connection relationship, and a "data access component" is added before the "component for ending the process", where a method for configuring a component required for updating the API interface from a pre-stored component template library is the same as the method in steps 1051 to 1054, and details are not repeated here. After the updating of the components and the component connection relationships is completed, an API interface corresponding to the interface updating requirement is generated based on the updated components and the component connection relationships, where the method for generating the API interface is the same as the method in step S106, and is not described herein again. Because the interface updating requirement is to add a component corresponding to the API interface to be updated, the interface updating requirement and the API interface corresponding to the interface updating requirement need to be stored in the mapping relation library in a mapping relation, so that the interface requirement can be directly used for calling in the mapping relation library when the API interface is used next time. Similarly, when the interface update requirement is to delete a component corresponding to an API interface to be updated, the interface update requirement and the API interface corresponding to the interface update requirement also need to be stored in the mapping relationship library in a mapping relationship.

For example, the obtained interface update requirement is "update the API interface for obtaining the client name in the client table to the API interface for obtaining the client phone in the client table", at this time, it is considered that the "data access component" in the original API interface needs to be changed to obtain the client phone in the client table, and the method of changing the configuration data according to the obtained interface update requirement is the same as the method in step S202, and is not described herein again. Because the interface updating requirement includes modifying the component corresponding to the API interface to be updated, the API interface corresponding to the interface updating requirement needs to be used to replace the API interface correspondingly stored in the mapping relation library, so that the updated API interface can be directly called when the same interface requirement is met next time.

Compared with the generation method of the API interface in the prior art, the generation method of the API interface provided in the embodiment of the present application may determine whether the API interface corresponding to the acquired interface requirement exists based on a mapping relationship library of the interface requirement and the API interface stored in advance, determine a configuration requirement for constructing the API interface if the API interface does not exist, configure a component required by the API interface according to the configuration requirement, generate configuration data, and generate the API interface that can meet the interface requirement after the configuration data passes an interface call test. If yes, judging whether the API interface meets the interface requirement, and if not, upgrading the API interface. According to the API interface generation method provided by the embodiment of the application, when the API interface is generated, the components required by the API interface are directly configured from the pre-stored component template library, and the configuration data are generated by dragging the components to generate the API interface, so that the code development steps required by the API interface generation can be reduced, the API interface can be generated more conveniently and rapidly, and the development period of a new API interface is greatly shortened. The method can also be used for directly modifying the existing API interface to generate a new API interface, thereby avoiding secondary development of the API interface, ensuring the stability of the existing API interface and enabling the use and management of the API interface to be more convenient.

Referring to fig. 4 and 5, fig. 4 is a first schematic structural diagram of an API interface generating device according to an embodiment of the present application, and fig. 5 is a second schematic structural diagram of an API interface generating device according to an embodiment of the present application. As shown in fig. 4, the generating means 300 includes:

an obtaining module 301, configured to obtain an interface requirement;

a judging module 302, configured to judge whether an API interface corresponding to the acquired interface requirement exists based on a mapping relationship library of prestored interface requirements and API interfaces;

a first determining module 303, configured to determine, if there is no API interface corresponding to the acquired interface requirement, a configuration requirement for constructing an API interface based on the acquired interface requirement;

a second determining module 304, configured to determine, based on the configuration requirement, components and component connection relationships required for building the API interface;

a configuration module 305, configured to configure components required by the API interface according to the component connection relationship from a pre-stored component template library;

the generating module 306 is configured to generate configuration data according to the configured component, and generate an API interface corresponding to the interface requirement based on the configuration data.

Further, as shown in fig. 5, the generating device further includes:

the first storage module 307 is configured to store the interface requirement and the API interface corresponding to the interface requirement into the mapping relationship library in a mapping relationship.

Further, the generating device further includes:

the calling module 308 is configured to call the API interface to perform data interaction if the API interface corresponding to the acquired interface requirement exists;

a modifying module 309, configured to modify, if the data acquired by calling the API interface does not meet the acquired interface requirement, the configuration data of the API interface corresponding to the acquired interface requirement according to the acquired interface requirement, and generate the API interface according to the modified configuration data;

a second storage module 310, configured to store the obtained interface requirement and the API interface generated according to the modified configuration data into the mapping relationship library in a mapping relationship.

Further, the configuration module 305 is further configured to:

selecting a component template required by the API from a pre-stored component template library;

generating a component in response to the determination of the component configuration parameters;

Further, the generating module 306 is further configured to:

and if the test result is different from the interface requirement, re-editing the component until the test result obtained by the component corresponds to the interface requirement of the API interface, and executing the step of generating the API interface corresponding to the interface requirement based on the configuration data.

Further, the generating apparatus 300 is further configured to:

receiving an interface updating requirement;

acquiring the API interface to be updated mapped by the interface updating requirement from the mapping relation library;

Referring to fig. 6, fig. 6 is a schematic structural diagram of an electronic device according to an embodiment of the present disclosure. As shown in fig. 6, the electronic device 400 includes a processor 410, a memory 420, and a bus 430.

The memory 420 stores machine-readable instructions executable by the processor 410, when the electronic device 400 runs, the processor 410 communicates with the memory 420 through the bus 430, and when the machine-readable instructions are executed by the processor 410, the steps of the API interface generation method in the method embodiments shown in fig. 1 and fig. 2 may be performed, which solves the problem of inconvenience in generating a new API interface and upgrading an API interface in the prior art.

An embodiment of the present application further provides a computer-readable storage medium, where a computer program is stored on the computer-readable storage medium, and when the computer program is executed by a processor, the steps of the method for generating an API interface in the method embodiments shown in fig. 1 and fig. 3 may be executed, so as to solve the problem in the prior art that generating a new API interface and upgrading the API interface are inconvenient, and a specific implementation manner may refer to the method embodiment and is not described herein again.

It can be clearly understood by those skilled in the art that, for convenience and simplicity of description, the specific working processes of the above-described systems, apparatuses and units may refer to the corresponding processes in the foregoing method embodiments, and are not described herein again.

In the several embodiments provided in the present application, it should be understood that the disclosed system, apparatus and method may be implemented in other ways. The above-described apparatus embodiments are merely illustrative, and for example, the division of the units into only one type of logical function may be implemented in other ways, and for example, multiple units or components may be combined or integrated into another system, or some features may be omitted, or not implemented. In addition, the shown or discussed mutual coupling or direct coupling or communication connection may be an indirect coupling or communication connection of devices or units through some communication interfaces, and may be in an electrical, mechanical or other form.

The units described as separate parts may or may not be physically separate, and parts displayed as units may or may not be physical units, may be located in one position, or may be distributed on multiple network units. Some or all of the units can be selected according to actual needs to achieve the purpose of the solution of the embodiment.

In addition, functional units in the embodiments of the present application may be integrated into one processing unit, or each unit may exist alone physically, or two or more units are integrated into one unit.

The functions, if implemented in the form of software functional units and sold or used as a stand-alone product, may be stored in a non-volatile computer-readable storage medium executable by a processor. Based on such understanding, the technical solution of the present application or portions thereof that substantially contribute to the prior art may be embodied in the form of a software product stored in a storage medium and including instructions for causing a computer device (which may be a personal computer, a server, or a network device) to execute all or part of the steps of the method according to the embodiments of the present application. And the aforementioned storage medium includes: various media capable of storing program codes, such as a usb disk, a removable hard disk, a Read-Only Memory (ROM), a Random Access Memory (RAM), a magnetic disk, or an optical disk.

It should be noted that: like reference numbers and letters refer to like items in the following figures, and thus once an item is defined in one figure, it need not be further defined and explained in subsequent figures, and moreover, the terms "first", "second", "third", etc. are used merely to distinguish one description from another and are not to be construed as indicating or implying relative importance.

Finally, it should be noted that: the above-mentioned embodiments are only specific embodiments of the present application, and are used to illustrate the technical solutions of the present application, but not to limit the technical solutions, and the scope of the present application is not limited to the above-mentioned embodiments, although the present application is described in detail with reference to the foregoing embodiments, those skilled in the art should understand that: any person skilled in the art can modify or easily conceive the technical solutions described in the foregoing embodiments or equivalent substitutes for some technical features within the technical scope disclosed in the present application; such modifications, changes or substitutions do not depart from the spirit and scope of the exemplary embodiments of the present application, and are intended to be covered by the scope of the present application. Therefore, the protection scope of the present application shall be subject to the protection scope of the claims.

Claims

1. A generation method of an API (application program interface), which is characterized by comprising the following steps:

acquiring interface requirements;

generating configuration data according to the configured components, and generating an API (application program interface) corresponding to the interface requirement based on the configuration data;

the configuration requirements include a data table and data attributes in the data table, and the configuration of the components required by the API interface according to the component connection relationship from a pre-stored component template library includes:

2. The generation method according to claim 1, characterized in that the generation method further comprises:

3. The generation method according to claim 1, characterized in that the generation method further comprises:

4. The generation method according to claim 1, wherein the component according to the configuration generates configuration data, and generates an API interface corresponding to the interface requirement based on the configuration data, including;

5. The generation method according to any one of claims 2 to 4, characterized in that the generation method further includes:

receiving an interface updating requirement;

6. An apparatus for generating an API interface, the apparatus comprising:

the acquisition module is used for acquiring interface requirements;

the generating module is used for generating configuration data according to the configured components and generating an API (application programming interface) corresponding to the interface requirement based on the configuration data;

the configuration module is configured to, when the configuration module is configured to configure the components required by the API interface according to the component connection relationship from a pre-stored component template library, further configure the components required by the API interface by using the configuration module:

7. The generation apparatus according to claim 6, characterized in that the generation apparatus further comprises:

and the first storage module is used for storing the interface requirement and the API interface corresponding to the interface requirement into the mapping relation library in a mapping relation.

8. An electronic device, comprising: a processor, a memory and a bus, the memory storing machine-readable instructions executable by the processor, the processor and the memory communicating via the bus when an electronic device is operated, the machine-readable instructions being executed by the processor to perform the steps of the method for generating an API interface according to any one of claims 1 to 5.

9. A computer-readable storage medium, characterized in that a computer program is stored on the computer-readable storage medium, which computer program, when being executed by a processor, performs the steps of the method for generating an API interface according to any one of claims 1 to 5.