KR102563179B1 - Automated rest api service creation for rest api client development, and method thereof - Google Patents

Abstract

A REST API server and its operating method are disclosed. A method of operating a REST API server according to an embodiment of the present invention includes registering meta information for a REST API (Representational State Transfer Application Program Interface) service, URI (Uniform Resource Resource) from meta information corresponding to a client request and scheduling. Identifier), analyzing the identified URI, generating source code and directories based on the registered REST API, determining source files for REST API services, and determining source files for connection to the determined source files. A step of generating a routing file, and a step of calculating a source code that performs a REST API service.

Description

Virtual REST API service automatic creation server and method for REST API client development {AUTOMATED REST API SERVICE CREATION FOR REST API CLIENT DEVELOPMENT, AND METHOD THEREOF}

The present invention relates to a server and method for automatically generating a virtual REST API service for developing a REST API client, and more particularly, to developing a REST API client that provides a REST API service that can satisfy the needs of both server developers and client developers. It relates to a server and method for automatically creating a virtual REST API service for

An API (Application Program Interface) is an interface provided by the server side so that a client can request a resource, and facilitates interaction between computer programs by providing a set of data and functions and enables information exchange between them.

REST API is the implementation of these APIs based on REST (Representational State Transfer). REST is one of the architectures that provides standards between web computer systems so that systems can easily communicate with each other. Currently, most public and private companies provide API services, making it a standard technology for web services.

Client developers use REST services in the development and maintenance phase when developing client programs using a cloud environment that provides REST APIs. Using REST services for a long time is very burdensome in terms of cost and management. there is a situation For example, if a client program is developed using API services of AWS Cloud and Google Cloud, the cost increases significantly depending on the usage time and server specifications.

Nevertheless, client developers want to frequently request and test REST API services in the development stage. Accordingly, server developers who build REST API simulation servers are under heavy workload due to tasks such as creating and adding source files that perform each API service one by one at the request of client developers.

In particular, there are many cases in which simple tasks are repeated in the course of preparing, building, and distributing source codes among server developers, and repetition of these simple tasks causes server developers to further increase their fatigue.

Therefore, when developing a client program using a cloud environment that provides a REST API, a method capable of satisfying business demands for both client developers and server developers is required.

Korean Registered Patent No. 10-2417742 (registered on July 1, 2022)

In order to solve the above problems, the technical problem to be achieved by the present invention is a virtual REST API service automatic generation server and method for developing a REST API client capable of implementing and creating a REST API service alone by a client developer without the help of a REST server developer. is presenting

The problems of the present invention are not limited to those mentioned above, and other problems not mentioned will be clearly understood by those skilled in the art from the description below.

As a means for solving the above-described technical problem, the method for automatically generating a virtual REST API service for developing a REST API client according to an embodiment of the present invention registers meta information for a REST API (Representational State Transfer Application Program Interface) service. step of identifying a Uniform Resource Identifier (URI) from meta information corresponding to a client's request and scheduling, analyzing the identified URI and creating a source code and directory based on the registered REST API, REST API It includes determining a source file for a service, generating a routing file for connection to the determined source file, and calculating a source code that performs a REST API service.

Preferably, registering meta information may create and register detailed information about a REST API service.

Also preferably, in the step of determining the source file, the outermost leaf node of the URI may be determined as the source file.

Also preferably, when a request for an API service is entered, the step of loading the REST API service code corresponding to the request by the generated routing file, and the step of transmitting response data for the REST API call may be further included. .

Also preferably, after the loading step, if the format conversion rule is set to be used, accessing the registered meta information using the loaded REST API service code and performing format conversion from the meta information according to a preset rule. may further include.

Also preferably, in the step of creating a directory, the directory may be automatically created in a recursive structure by parsing the URI based on the self-descriptiveness of the registered REST API.

Also preferably, in the step of creating a routing file, routes for all REST API services can be created in one routing file.

On the other hand, the virtual REST API service automatic generation server for REST API client development according to another embodiment of the present invention performs the REST API service by a registration unit registering meta information about the REST API service, and requests and scheduling from clients. and a main generation unit that calculates a source code to generate a source code, and the main generation unit identifies a URI (Uniform Resource Identifier) from meta information corresponding to a client's request and scheduling, and analyzes the identified URI to generate a registered REST API. Based on the directory creation unit that creates source code and directories, the decision unit that determines the source file for the REST API service, the file generation unit that creates the routing file for connection to the determined source file, and the REST API service that performs the It includes a source code calculation unit that calculates source code.

Preferably, the registration unit may create and register detailed information on the REST API service.

Also preferably, the determination unit may determine an outermost leaf node of the URI as a source file.

Also preferably, when a request to the REST API service is input, an output unit for loading a REST API service code corresponding to the request by the generated routing file and transmitting response data to the REST API call may be further included.

Also preferably, the output unit accesses registered meta information using the loaded REST API service code, when the format conversion rule is set to be used after loading the REST API service code, and from the meta information according to a preset rule. Format conversion can be performed.

Also preferably, the directory creation unit may automatically create a directory in a recursive structure by parsing the URI based on the self-expression structure of the registered REST API.

Also preferably, the file creation unit may create routes for all REST API services in one routing file.

According to the present invention, by registering the meta information for the REST API service in the database, a virtual REST API service automatic generation server for developing a REST API client in which a client developer can easily use the REST API service even without an additional action by a server developer. And it has the effect of providing a method.

As a result, it is possible to provide a REST API service that both server developers and client developers can be satisfied with. In addition, the development period using the REST API service can be shortened, and the cost required for development can be reduced.

The effects of the present invention are not limited to those mentioned above, and other effects not mentioned will be clearly understood by those skilled in the art from the description below.

1 is a configuration diagram of a system for automatically generating a virtual REST API service for developing a REST API client according to a preferred embodiment of the present invention;
Figure 2 is a block diagram of the main generator shown in Figure 1;
3 is a diagram illustrating a UI provided by a registration unit among REST servers according to the present invention;
4 is a diagram illustrating a routing file generated by a main generator of a REST server according to the present invention;
5 is a diagram illustrating a directory created by a main creation unit among REST servers according to the present invention;
6 is a flowchart for explaining the operation of the register of the REST server according to the present invention;
7 is a flowchart for explaining the operation of the main generation unit of the REST server according to the present invention, and
8 is a flowchart for explaining the operation of the output unit of the REST server according to the present invention.

The above objects, other objects, features and advantages of the present invention will be easily understood through the following preferred embodiments in conjunction with the accompanying drawings. However, the present invention is not limited to the embodiments described herein and may be embodied in other forms. Rather, the embodiments introduced herein are provided so that the disclosed content will be thorough and complete and the spirit of the present invention will be sufficiently conveyed to those skilled in the art.

In this specification, when an element is referred to as being on another element, it means that it may be directly formed on the other element or a third element may be interposed therebetween.

In this specification, when terms such as first and second are used to describe components, these components should not be limited by these terms. These terms are only used to distinguish one component from another. Embodiments described and illustrated herein also include complementary embodiments thereof.

Also, when it is said that a first element (or component) operates or is executed on (ON) a second element (or component), the first element (or component) means that the second element (or component) It should be understood that it is operated or executed in an environment in which it is operated or executed, or operated or executed through direct or indirect interaction with the second element (or component).

Where an element, component, device, or system is referred to as including a component consisting of a program or software, even if not explicitly stated otherwise, that element, component, device, or system means that the program or software executes or operates. It should be understood that it includes hardware (eg, memory, CPU, etc.) or other programs or software (eg, operating system or driver required to drive hardware) required to do so.

In addition, it should be understood that, unless otherwise specified, the element (or component) may be implemented in any form of software, hardware, or both software and hardware.

In addition, terms used in this specification are for describing embodiments and are not intended to limit the present invention. In this specification, singular forms also include plural forms unless specifically stated otherwise in a phrase. The terms 'comprises' and/or 'comprising' used in the specification do not exclude the presence or addition of one or more other elements.

1 is a configuration diagram of a system for automatically generating a virtual REST API service for developing a REST API client according to a preferred embodiment of the present invention.

Referring to FIG. 1, the system for automatically generating a virtual REST API service for developing a REST API client according to a preferred embodiment of the present invention is a server for automatically generating a virtual REST API service for developing a REST API client for developing a REST API client (hereinafter , referred to as a 'REST server') 100, a database 200, and a plurality of developer terminal devices 300.

The REST server 100 is a server for providing a virtual REST API service for developing a REST API client. A REST API is an application programming interface that conforms to the constraints of the REST architectural style and allows interaction with RESTful web services.

The REST server 100 registers meta information about the REST API service, and calculates source code for performing the REST API service by a client's request and scheduling. In addition, the REST server 100 provides a REST API service for a developer's request.

The REST server 100 includes a registration unit 110, a main generation unit 120, and an output unit 130. DjangoREST Framework may be applied to the REST server 100.

The registration unit 110 registers meta information about the REST API service. Meta information registered through the registration unit 110 is input from the developer terminal device 300, and registering meta information means an operation of creating and registering detailed information about a REST API service.

Detailed information on the REST API service may include title name, URI, response data, author, and type. Specific information types of detailed information have been exemplified, but additional types of information may be added depending on circumstances.

Meta information registered by the registration unit 110 is stored and stored in the database 200 according to standardized rules. Accordingly, the meta information can be freely modified and added as needed. The register 110 may be implemented by React JS.

The main generating unit 120 performs a REST API service corresponding to a client's request and scheduling. The main generator 120 will be described in more detail in FIG. 2 to be described later. The main generator 120 may be implemented by Python 3.9.

When a request for the REST API service is input, the output unit 130 loads the REST API service code corresponding to the request for the REST API service previously input by the pre-generated routing file, and response data for the REST API call. send

After loading the REST API service code, the output unit 130 accesses the meta information of the database 200 using the loaded REST API service code, when it is set to use the format conversion rule, and rules set from the meta information. Format conversion is performed by

The database 200 can store and manage all information necessary for the operation of the system for providing REST API services into a database. For example, the database 200 may store meta information about the REST API service input by the REST server 100, and may provide pre-stored meta information upon request from the REST server 100.

Meta information stored in the database 200 may be in the form of xml/json/text. Through the meta information stored in the database 200, a list and detailed information of all REST API services can be checked, and REST API services can be added, modified, and deleted according to a client's request. Database 200 may be implemented by postgresql-11.

The plurality of developer terminal devices 300 are terminal devices corresponding to client developers, and may register meta information about the REST API service in the REST server 100 . Here, the meta information may include the title name, URI, response data, creator, and type of the corresponding service.

FIG. 2 is a block diagram of the main generating unit shown in FIG. 1 .

Referring to FIG. 2 , the main generation unit 120 of the REST server 100 constituting the virtual REST API service automatic generation system for developing a REST API client according to the present invention will be described. As shown, the main generation unit 120 includes an identification unit 121, a directory creation unit 122, a determination unit 123, a file generation unit 124, and a source code calculation unit 125.

The identification unit 121 identifies a URI (Uniform Resource Identifier) from meta information corresponding to a client's request and scheduling. A URI stands for Uniform Resource Identifier, and is a unique address representing a resource on the Internet.

The directory creation unit 122 analyzes the URI identified by the identification unit 121 and creates a source code and directory based on a pre-registered REST API. At this time, the directory creation unit 122 may automatically create a directory in a recursive structure by parsing the URI based on the self-descriptiveness of the registered REST API.

The determination unit 123 determines a source file for a REST API service. At this time, the determination unit 123 may determine the source file by an operation of taking a string of an outermost leaf node of the URI.

For example, the URI present in the detailed information about the REST API service is "http://[domain]/[uri-0]/[uri-1]/[uri-3]/[uri-4]" can be in the form At this time, the determination unit 123 may determine by "[uri-4]", which is a string of the outermost leaf node of the URI.

The file creation unit 124 creates a routing file (route.urls) for connection to the source file determined by the determination unit 123. At this time, the file creation unit 124 may create each routing file for each REST API service, or may create a route for all REST API services in one file.

The source code calculator 125 calculates source code for performing REST API services.

3 is a diagram illustrating a UI provided by a registration unit among REST servers according to the present invention.

The UI shown in FIG. 3 corresponds to the UI provided from the registration unit 110 to the developer terminal device 300, and a list display area A of previously registered REST API services is displayed on one side of the UI, and REST API services shown in FIG. On the side of the API service list display area (A), a meta information input area (B) for entering meta information is displayed.

In the list display area (A) of REST API services, registration date, service name, build status, API name, and URI of meta information about previously registered REST API services are displayed in a list form in a preset order.

In the meta information input area (B), input information required for meta information registration, such as API name, URI, registrant name, service model, response format, and detailed description of REST API service, etc. Windows are provided.

4 is a diagram illustrating a routing file generated by a main generator of a REST server according to the present invention.

The file creation unit 124 creates a routing file for connection to the source file determined for the REST API service. A routing file automatically generated by the file generator 124 is illustrated in FIG. 4 . A routing file can be in the form of route.urls.

5 is a diagram illustrating a directory created by a main creation unit among REST servers according to the present invention.

The directory creation unit 122 automatically creates a directory in a recursive structure by parsing the URI based on the self-descriptiveness of the REST API. A hierarchical directory automatically created by the directory creation unit 122 is illustrated in FIG. 5 .

6 is a flowchart for explaining the operation of the registration unit of the REST server according to the present invention.

The developer inputs meta information about the REST API service through the developer terminal device 300 (S410). At this time, the meta information input by the developer may include a title name, URI, response data, author, and type.

When meta information about the REST API service is input through the developer terminal device 300, the registration unit 110 registers the meta information about the REST API service in the database 200 (S420). Meta information about REST API services registered in the database 200 may be modified and added.

7 is a flowchart for explaining the operation of the main generation unit of the REST server according to the present invention.

In this embodiment, it is assumed that meta information for a plurality of REST API services is pre-registered by the registration unit 110 . When a REST API service request is input from a client or a REST API service according to scheduling is requested, the identification unit 121 identifies a corresponding URI (S510).

When the URI is identified by the identification unit 121, the directory creation unit 122 analyzes the identified URI and creates a source code and directory based on the REST API service previously registered in the database 200 (S520).

When the source code and directory are created, the determination unit 123 determines the source file for the REST API service (S530), and the file creation unit 124 creates a routing file for connection to the source file (S540). .

Finally, the source code calculation unit 125 calculates the source code for performing the REST API service. Steps S510 to S540 correspond to operations performed in the main generating unit 120 .

8 is a flowchart for explaining the operation of the output unit of the REST server according to the present invention.

When a request to the REST API service is entered (S610). The output unit 130 loads the REST API service code corresponding to the request input in step S610 by the routing file (S620).

If the format conversion rule is set to be used by the request input in step S610 (S630-Y), the output unit accesses pre-registered meta information (S640) and performs format conversion using the corresponding meta information (S650). . Then, the output unit 130 transmits response data (S660).

By this operation, the developer registers the meta information about the REST API service in the database 200, and can add or modify it as needed. Therefore, when a client developer uses the REST API service, there is no need to make a separate request to the server developer, so the REST API service can be implemented more easily and the time required for development can be reduced.

Those skilled in the art to which the present invention pertains will understand that the present invention may be embodied in other specific forms without changing its technical spirit or essential features. Therefore, the embodiments described above should be understood as illustrative in all respects and not limiting. The scope of the present invention is indicated by the following claims rather than the detailed description above, and all changes or modifications derived from the meaning and scope of the claims and equivalent concepts should be construed as being included in the scope of the present invention. do.

100: REST server
110: register
120: main generating unit
130: output unit
200: database
300: a plurality of developer terminal devices

Claims (14)

Registering meta information for a REST API (Representational State Transfer Application Program Interface) service;
identifying a Uniform Resource Identifier (URI) from meta information corresponding to a client's request and scheduling;
Analyzing the identified URI and generating a source code and directory based on the registered REST API;
determining a source file for the REST API service;
generating a routing file for connection to the determined source file;
Calculating source code for performing the REST API service;
If a request for a REST API service is input, loading a REST API service code corresponding to the request by the generated routing file; and
Transmitting response data for the REST API call; Including,
In the step of determining the source file, determining the outermost leaf node of the URI as the source file;
The method of automatically generating a virtual REST API service for developing a REST API client, characterized in that the generated routing file is in the form of route.urls. According to claim 1,
The step of registering the meta information is a virtual REST API service automatic generation method for developing a REST API client, characterized in that for creating and registering detailed information on the REST API service. delete delete According to claim 1,
After the loading step,
accessing the registered meta information using the loaded REST API service code when it is set to use a format conversion rule; and
The method of automatically generating a virtual REST API service for developing a REST API client, further comprising: performing format conversion from the meta information according to a preset rule. According to claim 1,
In the step of creating the directory, the directory is automatically created in a recursive structure by parsing the URI based on the Self-descriptiveness of the registered REST API. How to automatically create a REST API service. According to claim 1,
The step of generating the routing file is a method of automatically generating a virtual REST API service for developing a REST API client, characterized in that for creating a route for the entire REST API service in one routing file. A registration unit that registers meta information about REST API services; and
A main generator that calculates a source code for performing a REST API service by a client's request and scheduling; includes,
The main generator,
an identification unit that identifies a URI (Uniform Resource Identifier) from meta information corresponding to the client's request and scheduling;
a directory creation unit that analyzes the identified URI and creates a source code and directory based on the registered REST API;
a determination unit for determining a source file for the REST API service;
a file creation unit generating a routing file for connection to the determined source file;
a source code calculation unit for calculating source code for performing the REST API service; and
When a request for the REST API service is input, an output unit for loading a REST API service code corresponding to the request by the generated routing file and transmitting response data to the REST API call;
The determining unit determines an outermost leaf node of the URI as the source file;
The virtual REST API service automatic creation server for REST API client development, characterized in that the routing file generated by the file creation unit is in the form of route.urls. According to claim 8,
The registration unit, virtual REST API service automatic generation server for developing a REST API client, characterized in that for creating and registering detailed information on the REST API service. delete delete According to claim 8,
The output unit, after loading the REST API service code, accesses the registered meta information using the loaded REST API service code, if it is set to use a format conversion rule, and uses the meta information to a predetermined rule. A virtual REST API service automatic generation server for developing a REST API client, characterized in that performing format conversion by. According to claim 8,
The directory creation unit parses the URI based on the self-expression structure of the registered REST API and automatically creates the directory in a recursive structure. According to claim 8,
The file generation unit, virtual REST API service automatic generation server for developing REST API clients, characterized in that for creating a route for the entire REST API service in one routing file.

Images