WO2021215864A1

WO2021215864A1 - Api gateway accelerator system and method

Info

Publication number: WO2021215864A1
Application number: PCT/KR2021/005138
Authority: WO
Inventors: 송영관
Original assignee: 주식회사 모비젠
Priority date: 2020-04-23
Filing date: 2021-04-23
Publication date: 2021-10-28
Also published as: KR20210130989A

Abstract

The present invention relates to an API caching system, and a service is provided under the environment of an API gateway server that unifies endpoints of all API servers.　Provided is a REST-based accelerator system comprising: an API gateway for determining whether or not to provide and service an endpoint for receiving an API user's request message and transmitting to an uniform resource identifier (URI) registered by an API provider; a cache server for determining whether or not to cache by analyzing the request message, receiving a response message by requesting from an API server, and reusing upon request for the same message by storing for a storage period; and the API server created by the API provider.

Description

API Gateway Accelerator System and Method

The present invention relates to an API gateway accelerator system and method, and more particularly, to an API gateway accelerator system and method for providing a service utilizing web caching technology under an API gateway server environment that unifies the endpoints of all API servers. will be.

API gateway technology that provides access control, service routing, traffic control, etc. is applied to the current generalized API service providing systems, so a number of API endpoints are unified and serviced.

Due to this, when a large number of external requests are made, the response speed of the API service with a complex processing structure is slowed and the load of the backend service is increased, so there is a limit in which there is no choice but to choose the next best solution such as infrastructure expansion or traffic restriction.

The technical problem to be solved by the present invention is to provide a system and method for improving response speed and reducing service load for an API service having a complex processing structure in an API gateway environment.

A system according to an embodiment of the present invention for solving the above technical problem is an API gateway accelerator system for processing a processing procedure in an API management portal service to configure a service infrastructure of a PI server and a cache server, the device is, a registration module for registering API specifications by checking whether a cache service is available; a configuration module for configuring environment information for executing the cache server; a distribution module for distributing execution information for executing a service based on the environment information; and a statistical analysis module for processing a response message for an API request received by the API gateway by checking whether the cache is serviced or not.

A method according to another embodiment of the present invention for solving the technical problem may be an API gateway web caching service providing method implemented by the API gateway accelerator system.

When making an API call that undergoes complex processing according to an embodiment of the present invention, it is possible to minimize the API response delay time by using the web cache function and minimize the internal call of the API system to minimize the system load.

According to an embodiment of the present invention, even a beginner API provider can easily apply a web caching function to the system without web caching related coding only by setting on the screen provided.

1 is a conceptual diagram of a system to which an API gateway accelerator system and method according to an embodiment of the present invention is applied.

FIG. 2 is a diagram illustrating a flow chart of a service in terms of an API user and an API provider according to an embodiment of the present invention.

3 is a diagram illustrating a flow chart of a service in terms of an API user and an API provider according to another embodiment of the present invention.

4 is a diagram illustrating a service configuration in terms of API users and API providers according to an embodiment of the present invention.

5 is a diagram illustrating an API gateway, a cache server, and an API server configuration module according to an embodiment of the present invention.

6 is a diagram illustrating the overall operation of the API gateway accelerator system and method according to an embodiment of the present invention.

In the system, the registration module, API gateway accelerator system, characterized in that it can selectively perform the configuration of an API service infrastructure having a complex processing structure or a general API service infrastructure configuration.

In the system, the configuration module is automatically configured based on registration information that is a processing result of the registration module without complex configuration input for the API cache infrastructure configuration, and the distribution module executes the execution based on the registration information It may be characterized by distributing information.

In the system, the statistical analysis module may be characterized in that it performs cache statistics processing processed by the API cache service executed based on the API cache infrastructure configuration configured by the configuration module and the distribution module.

Hereinafter, embodiments of the present invention will be described in detail with reference to the accompanying drawings. Objects, features, and effects of the present invention described above may be understood through embodiments associated with the drawings. However, the present invention is not limited to the embodiments described herein, and may be applied and modified in various forms. Rather, the embodiments of the present invention to be described later clarify the technical idea disclosed by the present invention, and furthermore, it is provided so that the technical idea of the present invention can be sufficiently conveyed to those of ordinary skill in the art to which the present invention pertains. . Accordingly, the scope of the present invention should not be construed as being limited by the examples to be described later. On the other hand, the same reference numbers in the following examples and drawings indicate the same components.

In addition, identification symbols (eg, A, B, C, etc.) in each step are used for convenience of explanation, and the identification code does not describe the order of each step, and each step is clearly specified in context. Unless the order is specified, the order may differ from the specified order. That is, each step may occur in the same order as specified, may be performed substantially simultaneously, or may be performed in the reverse order.

All terms used herein have the same meaning as commonly understood by one of ordinary skill in the art to which the present invention belongs, unless otherwise defined. Terms defined in general used in the dictionary should be interpreted as being consistent with the meaning in the context of the related art, and cannot be interpreted as having an ideal or excessively formal meaning unless explicitly defined in the present application.

Referring to FIG. 1 , the API gateway accelerator system 10 includes an API gateway 100 , a cache server 111 , an API server 113 , and an API management portal 120 . An API configuration with a complex process (hereinafter, '(a)') can be configured together by tying an API server and a cache server, and an API configuration without a complex process (hereinafter, '(B)') is an API server can only be configured. The server group according to the combination of (A) and (B) is composed of API gateway back-end service.

The API gateway 100 represents all API servers 115 and provides a unified API endpoint (URI path exposed to the outside) to API users, and the cache server 200 responds to the API server possessing a complex process. Store and manage messages to minimize the response time of the API gateway.

The cache server 111 and API server 113 of (A), which are API components possessing a complex processing process, store the response message of the API server in the cache server when making an API request, and do not request to the API server when making an API request later. Without 　, the cache server responds to the stored message to improve the server load and response speed.

The API server 113 of (B), which is an API configuration without a complex processing process, performs response processing for API requests.

The API management portal 120 can easily and effectively support server creation, deletion, monitoring, etc. for server configuration and management for the combination of (A) and (B).

In addition, in the API management portal 500 　Open Stack, VMware, AWS (Amazon Web Service), GCP (Google Cloud Platform), Cloud), public cloud (Public Cloud), hybrid cloud (Hybrid Cloud), such as deployment models can be supported, so that the API server configuration can be provided according to the service type desired by the user.

In addition, FIG. 3 is a diagram showing a flow chart of a service in terms of an API user and an API provider according to another embodiment of the present invention.

Referring to FIG. 2 , the API user side may include an API request reception and verification step (S210), an API request delivery step (S250), an API analysis step (S250), and an API response message return step (S270).

API request reception and verification (S210) step is a function of providing a message verification function by combining the API request message received by the API gateway 100 with URI information and HTTP header information, and passing the message that does not pass verification to an error step provides

The API request delivery step (S230) provides a service routing function that can deliver an API request message in an API configuration that has a complex processing process registered by the API provider (a) or an API configuration that does not have a complicated processing process.

The API analysis step (S250) analyzes the HTTP header information of the API response message received to the API gateway 100 and updates the cache statistics information of the corresponding API service according to whether the cache is serviced or not, so that the cache usage in the API management portal 120 later Provides functions to be used as statistics.

The API response message return step (S270) is a function of directly delivering the processing result of the API analysis step (S250) including the API request reception and verification (S251) to the API analysis step (S255) to the API user in accordance with the response message standard. provides

Subsequently, referring to FIG. 3 , from the API provider side, it may include an API specification registration step (S310), an API configuration step (S330), and a server distribution (S350) step through the API management portal 500 service.

The API specification registration step (S310) receives essential inputs such as the API classification system, which is the basic configuration in which API information is exposed, data source, distribution cycle, revision date, description, creation date, and access right from the API provider for API service. Provides a function to generate basic information.

The API configuration step (S330) provides a function of automatically performing at least one of the server environment configuration for the API configuration of (A) or the API configuration of (B) referenced in FIG. 1 .

In addition, in the case of API configuration of 　 (A), it provides a function to select directory-based configuration or extension-based configuration within URI.

In the server distribution (S350) step, an executable image is created and distributed based on the environment information automatically configured in the API configuration step (S330) step and is added to the service routing information of the API gateway 100. In addition, the executable image may provide a function for distributing the desired service type (Docker image, executable compressed file) by the user.

Referring to FIG. 4 , in terms of API users, it includes an API gateway 100 , a cache server 111 , and an API server 113 . Although the API gateway is basically configured as one unit, it may be provided in an HA (High Availability) configuration that binds several units into one. A cache server and an API server can also be provided in an HA configuration that bundles multiple units.

In addition, a configuration in which the cache server 111 and the API server 113 are bundled in one server configuration 110 may be provided. This configuration is performed through the distribution module 125 of the API management portal 120 and depends on the type of service desired by the user.

Referring to FIG. 4, in terms of API providers, the API management portal 120 includes a registration module 121, a configuration module 123, a distribution module 125 and a statistics module 127, and all modules are UI/UX. components together. The registration module 121 includes a function for registering API basic information and cache configuration. The configuration module 123 provides a function of automatically generating settings for configuring the API and cache server with reference to the API basic information and whether the cache is configured. The distribution module 125 provides a function of distributing an API service based on the automatically generated server configuration information. In addition, the configuration module 127 shows the generated configuration information to be confirmed to the API provider, and may also provide a correction function. In addition, the distribution module 125 may provide a function to check the generation/distribution performance log for the server and a function to access the generated server.

Referring to FIG. 5 , the API gateway filtering service system 120 includes a request control module 121 , a traffic control module 123 , a service routing module 125 , and a statistical analysis module 127 .

The API request message sent by the API user is received by the API gateway, records the request message in the log through the request control module 121, performs validation, and passes to the error stage when validation fails. By comparing the threshold value of traffic control settings such as the number of API executions per day and the number of API executions per hour set by the API provider, it passes to the error stage when the threshold is exceeded, and is distributed by the API provider in the service routing module 125 when the threshold is less than the threshold It is routed to the API cache server or API server, receives a response message, analyzes HTTP headers in the statistical analysis module 127, parses cache-related tag information, updates cache statistics information, and if there is an error in the middle, it passes to the error stage.

Referring to Figure 5, 　 cache server setting service 210 includes a 　 cache policy storage module 211, policy application module 212, and records all of the performance log in the designated path. The API provider creates a cache policy storage module 211 created through the distribution module 125 of the API management portal 120 of FIG. The cache server is started through the policy application module 212 . Referring to FIG. 5 , contents may be different for each service in an API provider service-friendly manner.

More specifically, FIG. 6 is a diagram illustrating a flow for explaining the overall operation of the API gateway accelerator system and method according to an embodiment of the present invention. The diagram includes a cache server configuration.

Referring to FIG. 6 , the API provider creates a cache server and an API server group within the allowed infrastructure configuration through the API management portal 120 and registers an endpoint for the new API service in the API gateway (S610). .

Referring to FIG. 6 , the API user sends an API request message to the API gateway based on the exposed API information, and the API gateway performs the next step if it is within a threshold set through validation of the message and traffic control (S615) .

When there is no message in the cache, the cache server makes a request to the API server (S620 and S625), receives a response message, and stores it in the storage (S630).

The cache server performs API delivery by writing the set validity period and caching hit, miss, and expire information in the header of the response message (S635).

Also, the API gateway analyzes the header information of the response message, records cache statistics, and then delivers the API response message to the API user (S640).

When the user (S650) who has received the API response message requests the same API from another API user (S655), the API gateway performs the same step S615 and determines whether the stored API request object is valid, and exceeds the cache hit (Hit). After setting to one of (Expire), when the validity is exceeded, the same steps S660 and S680 as those of S630 and S640 are performed. Otherwise, the API delivery (S675), cache statistics (S680) and API response (S685) steps are sequentially performed.

The system according to an embodiment of the present invention can minimize the API response delay time by utilizing the web cache function when making an API call that undergoes complex processing, and minimize the system load by minimizing the call inside the API system.

The embodiment according to the present invention described above may be implemented in the form of a computer program that can be executed through various components on a computer, and such a computer program may be recorded in a computer-readable medium. In this case, the medium includes a hard disk, a magnetic medium such as a floppy disk and a magnetic tape, an optical recording medium such as CD-ROM and DVD, a magneto-optical medium such as a floppy disk, and a ROM. , RAM, flash memory, and the like, hardware devices specially configured to store and execute program instructions.

Meanwhile, the computer program may be specially designed and configured for the present invention, or may be known and used by those skilled in the computer software field. Examples of the computer program may include not only machine language codes such as those generated by a compiler, but also high-level language codes that can be executed by a computer using an interpreter or the like.

The specific implementations described in the present invention are only examples, and do not limit the scope of the present invention in any way. For brevity of the specification, descriptions of conventional electronic components, control systems, software, and other functional aspects of the systems may be omitted. In addition, the connection or connection members of the lines between the components shown in the drawings exemplarily represent functional connections and/or physical or circuit connections, and in an actual device, various functional connections, physical connections that are replaceable or additional may be referred to as connections, or circuit connections. In addition, unless there is a specific reference such as “essential” or “importantly”, it may not be a necessary component for the application of the present invention.

In the specification of the present invention (especially in the claims), the use of the term “above” and similar referential terms may be used in both the singular and the plural. In addition, when a range is described in the present invention, each individual value constituting the range is described in the detailed description of the invention as including the invention to which individual values belonging to the range are applied (unless there is a description to the contrary). same as Finally, the steps constituting the method according to the present invention may be performed in an appropriate order unless the order is explicitly stated or there is no description to the contrary. The present invention is not necessarily limited to the order in which the steps are described. The use of all examples or exemplary terms (eg, etc.) in the present invention is merely for the purpose of describing the present invention in detail, and unless defined by the claims, the scope of the present invention is limited by the examples or exemplary terminology. it's not going to be In addition, those skilled in the art will recognize that various modifications, combinations, and changes may be made in accordance with design conditions and factors within the scope of the appended claims or their equivalents.

Claims

As an API gateway accelerator system for processing processing procedures in the API management portal service to configure the service infrastructure of the API server and the cache server,

The device is

a registration module for registering API specifications by checking whether a cache service is available;

a configuration module for configuring environment information for executing the cache server;

a distribution module for distributing execution information for executing a service based on the environment information; and

A process for analyzing a response message for an API request received by the API gateway, a statistical analysis module for checking whether the cache service is there or not;
According to claim 1,

The registration module is

An API gateway accelerator system having a feature that can selectively perform an API service infrastructure configuration having a complex processing structure or a general API service infrastructure configuration.
According to claim 1,

The component module is

It is automatically configured based on the registration information that is the processing result of the registration module without entering a complex configuration for the API cache infrastructure configuration,

The distribution module is

An API gateway accelerator system, characterized in that distributing the execution information based on the registration information.
According to claim 1,

The statistical analysis module,

An API gateway accelerator system, characterized in that the cache statistics processing processed by the API cache service executed based on the API cache infrastructure configuration configured by the configuration module and the distribution module is performed.