CN109460223B - API gateway management system and method thereof - Google Patents
API gateway management system and method thereof Download PDFInfo
- Publication number
- CN109460223B CN109460223B CN201811350232.4A CN201811350232A CN109460223B CN 109460223 B CN109460223 B CN 109460223B CN 201811350232 A CN201811350232 A CN 201811350232A CN 109460223 B CN109460223 B CN 109460223B
- Authority
- CN
- China
- Prior art keywords
- api
- parameter
- converter
- verifier
- verifying whether
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Active
Links
Images
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/30—Creation or generation of source code
Abstract
The invention discloses an API gateway management method, which comprises the following specific steps of defining metadata and parameters of an API of an access system; combining metadata definition and parameter definition to form an interface template; dynamically binding a service variable by an interface template, and transferring and synthesizing dynamic specific service parameters through an external system; combining the interface template and the dynamic service parameters to perform API parameter replacement and form a calling example by a computer; the calling instance calls the external system and outputs the event through the calling driver. By adopting the API gateway management method and the system based on the method, the invention carries out interface templating and informatization on a plurality of complicated APIs and combines dynamic data parameters to form a templated calling example, the development efficiency is high, the system applicability is higher along with the accumulation of various APIs, the workload of development and test is reduced, and the labor cost is saved.
Description
Technical Field
The invention relates to an API gateway management system and a method thereof.
Background
The API is an interactive mode for mutual communication between application systems, but because the difference between different systems is large, the types of API interfaces are numerous and the forms are different, the development task is heavy, the API joint debugging test is more, the development and test workload is large, and the efficiency is low.
Disclosure of Invention
The invention aims to provide an API gateway management system and a method thereof, which abstract numerous and complex APIs to further standardize and informationize, are suitable for various APIs, improve the development efficiency, reduce the workload of development and test, improve the code utilization rate, save the labor cost, greatly improve the reusability and form formulated development without compiling codes. Developers may also reduce skills, thereby creating non-developer configurations and enablers.
In order to achieve the above object, the present invention provides an API gateway management method, which comprises the following steps,
step S1: metadata definition and parameter definition are carried out on an API of the access system;
step S2: combining metadata definition and parameter definition to form an interface template;
and step S3: the interface template dynamically binds service variables and is transferred and synthesized into dynamic specific service parameters through an external system;
and step S4: combining the interface template and the dynamic service parameters to perform API parameter replacement and calculation to form a calling example;
step S5: and the calling instance calls the external system and outputs the event through the calling driver.
Further, the metadata definition includes API name, API code, API description, connection protocol, request URL and method, and parameter format, and the parameter template definition and the template variable definition are obtained through the parameter verifier and the parameter converter.
Further, the external system invocation comprises service invocation, test or operator verification invocation and system self-checking automatic verification invocation, and the event output comprises notification and alarm output.
An API gateway management system based on the method comprises,
the access module is used for accessing a plurality of service systems into the API gateway;
the system monitoring module is used for monitoring the use state of the system;
the API management module is used for defining, viewing, modifying, converting the API into a template, verifying parameters, binding and converting, visually testing and managing the life cycle of the API;
the API log module comprises an API management operation log, an API request log and an API routing log;
an API control module for processing API requests;
a system management module for validator and translator management and parameter configuration.
Preferably, the system monitoring module monitors metrics, threads, components, health and environmental information, the metrics including operating memory usage rate, and the operating memory usage rate displays the used memory, the remaining memory and usage proportion of each part through a proportion disk.
Preferably, the API definition can be dynamically newly created, deleted, modified and tested in the API definition list, and the API capability is increased in real time; the API with various protocol isomerism, parameters and format isomerism is converted into a unified API with a specification through a parameter template, an input parameter template comprises one or more API parameter variables, the variables are dynamically bound with a plurality of verifiers, and an up parameter variable sets a verification and verification rule in a lower parameter list; similarly, the output parameters also define the template, the template variables bind with the converter, the downlink parameter variables set the conversion rules in the parameter list at the bottom, and various API parameters are solidified and customized privately.
Preferably, the parameter verification and conversion converts the templated API into a standardized API for facilitating user invocation, each parameter is provided with a plurality of verifiers or converters, the verifiers include a null parameter verifier for verifying whether the parameter is null, a repeat request verifier for verifying whether the parameter is repeated within a specified time range, a number verifier for verifying whether the parameter is all numeric, a letter verifier for verifying whether the energy is all alphabetical, a number letter verifier for verifying whether the parameter is all numeric or alphabetical, a URL verifier for verifying whether the parameter is legal for a URL address, a minimum length verifier for verifying whether the parameter length is less than a specified length, a maximum length verifier for verifying whether the energy length is greater than a specified length, an XML format verifier for verifying whether the parameter is legal for XML data, a JSON format verifier for verifying whether the parameter is legal for JSON data, a Base64 coding verifier for verifying whether the parameter is legal for a Base64 verifier for verifying whether the time parameter is legal for a time difference range, an identifier verifier for verifying whether the IP is legal for an IP address, and a unique identifier for verifying whether the identifier is a unique identifier for the IP address, the converter comprises a universal converter, an encryption/decryption converter, a format converter and a private converter, wherein the universal converter comprises a serial number generation converter, a timestamp generation converter, a dictionary sequence signature converter, a time format escape converter, a time formatting converter, a parameter connection converter and a numerical value converter; the encryption and decryption converter comprises an MD5 signature converter, an SHA1 encryption converter, an RSA encryption converter, a Base64 converter and an RSA + Base64 converter; the format converter comprises an XML format converter and a JSON format converter; the private translator is a custom type translator.
Preferably, the API selected for the visual test displays basic information, request information, and error information of the API through a system interface to achieve visualization of the function verification process and the result, where the API operation log is a modification log during API configuration, and the API request log is a log recorded when a caller sends an API request to the server.
Preferably, for each API, life cycle management is required, and the API cycle state includes four states, namely a draft state in which definition is not completed, a test state in which test use is possible, a release state in which release to the production environment is possible and which can be dynamically loaded, and a down state in which the API is no longer used.
Preferably, the processing of the API request in the API control module includes whitelist control, API flow control and API route control, the whitelist limits that a designated host can access the system, the API flow control supports the limitation of the system on API access frequency, limits the API flow, and causes too fast a message to impact the system, and the API route control refers to how to process the API request.
Therefore, the API gateway management system and the method thereof adopting the structure carry out interface templating on a plurality of complex APIs and combine with dynamic data parameters to form a templated calling example, the development efficiency is high, along with the accumulation of various APIs, the system applicability is higher, the workload of development and test is reduced, the labor cost is saved, meanwhile, the reusability is greatly improved, and the configuration development without coding can be carried out. Developers may also reduce skills, thereby creating non-developer configurations and enablers.
The technical solution of the present invention is further described in detail by the accompanying drawings and embodiments.
Drawings
FIG. 1 is a schematic flow chart of an API gateway management system according to the present invention;
fig. 2 is a schematic structural diagram of an API gateway management system according to the present invention.
Detailed Description
Examples
Fig. 1 is a schematic flow chart of an API gateway management system according to the present invention, and as shown in fig. 1, a method for API gateway management includes the following steps,
step S1: metadata definition and parameter definition are performed on the API of the access system. The metadata definition comprises an API name, an API code, an API description, a connection protocol, a request URL and method and a parameter format, and the parameter template definition and the template variable definition are obtained through a parameter verifier and a parameter converter.
Step S2: an interface template is formed in combination with the metadata definition and the parameter definition.
And step S3: the interface template dynamically binds the service variables, and the dynamic specific service parameters are transferred and synthesized through an external system. The dynamic specific service parameters comprise telephone numbers and the like, the external system call comprises service call, test or operator verification call and system self-checking automatic verification call, and the event output comprises notification and alarm output.
And step S4: and combining the interface template and the dynamic service parameters to perform API parameter replacement and calculation to form a calling example.
Step S5: and the calling instance calls the external system and outputs the event through the calling driver.
An API gateway management system based on the method comprises,
and the access module is used for accessing the service systems into the API gateway.
And the system monitoring module is used for monitoring the use state of the system.
The system monitoring module monitors measurement, threads, components, health and environment information, wherein the measurement comprises the operating memory utilization rate, and the operating memory utilization rate displays the used memory, the residual memory and the use ratio of each part through a ratio disk.
The API management module is used for defining, viewing, modifying, converting the API into a template, verifying parameters, binding and converting, visually testing and managing the life cycle of the API.
API definition, in the API definition list, the API definition can be dynamically created, deleted, modified and tested, and the API capability is increased in real time; the API with various protocol isomerism, parameters and format isomerism is converted into a unified API with a specification through a parameter template, an input parameter template comprises one or more API parameter variables, the variables are dynamically bound with a plurality of verifiers, and an upstream parameter variable sets a verification and verification difficulty rule in a parameter list under the control; similarly, the output parameters also define the template, the template variables bind with the converter, the downlink parameter variables set the conversion rules in the parameter list at the bottom, and various API parameters are solidified and customized privately.
The parameter verification and conversion converts the templated API into a standardized API for facilitating user invocation, each parameter is provided with a plurality of verifiers or converters, each verifier comprises a null parameter verifier for verifying whether the parameter is null, a repeated request verifier for verifying whether the parameter is repeated within a specified time range, a digital verifier for verifying whether the parameter is all digital, a letter verifier for verifying whether the energy number is all letter, a digital letter verifier for verifying whether the parameter is all digital or letter, a URL verifier for verifying whether the parameter is legal URL address, a minimum length verifier for verifying whether the parameter length is less than a specified length, a maximum length verifier for verifying whether the energy number length is greater than the specified length, an XML format verifier for verifying whether the parameter is legal XML data, a JSON format verifier for verifying whether the parameter is legal JSON data, a Base64 coding verifier for verifying whether the parameter is legal 64 verifier for verifying whether the parameter is legal, a timestamp verifier for verifying whether the time parameter is within a specified time range, an IP identifier converter for verifying whether the IP address is legal and a unique identifier converter for generating a private signature, a universal signature converter, and a universal signature converter for generating a private time stream converter; the encryption and decryption converter comprises an MD5 signature converter, an SHA1 encryption converter, an RSA encryption converter, a Base64 converter and an RSA + Base64 converter; the format converter comprises an XML format converter and a JSON format converter; the private translator is a custom type translator. And during visual testing, the API selected for testing displays the basic information, the request information and the error information of the API through a system interface, so that the function verification process and the result visualization are realized. And the life cycle management is required to be carried out on each API, and the API cycle state comprises four states of draft state which is not defined yet, test state which can be used for testing, release state which is released to a production environment and can be loaded dynamically, and lower state which is not used any more by the API.
And the API log module comprises an API management operation log, an API request log and an API route log. The API operation log refers to a modification log during API configuration, and the API request log refers to a log recorded when a caller sends an API request to a server.
An API control module to process API requests. The API request processing in the API control module comprises white list control, API flow control and API route control, a host specified by white list limitation can access the system, the API flow control supports the limitation of the system on API access frequency, the API flow control limits the API, the impact of excessive and rapid messages on the system is avoided, and the API route control refers to how the API request is processed.
A system management module for validator and translator management and parameter configuration.
Therefore, the API gateway management system and the method thereof adopting the structure carry out interface templating on a plurality of complicated APIs and form a templated calling example by combining dynamic data parameters, have high development efficiency, have higher system applicability along with the accumulation of various APIs, reduce the workload of development and test, save the labor cost, greatly improve the reusability, and form the formulated development without compiling codes. Developers may also reduce skills, thereby creating non-developer configurations and enablers.
The above is a specific embodiment of the present invention, but the scope of the present invention should not be limited thereto. Any changes or substitutions which can be easily made by those skilled in the art within the technical scope of the present invention disclosed herein shall be covered by the protection scope of the present invention, and therefore the protection scope of the present invention shall be subject to the protection scope defined by the appended claims.
Claims (5)
1. An API gateway management method, characterized by: the method comprises the following specific steps of S1: metadata definition and parameter definition are carried out on an API of the access system; step S2: combining metadata definition and parameter definition to form an interface template; and step S3: dynamically binding the service variables by the interface template, and transferring and synthesizing specific dynamic service parameters by an external system; and step S4: combining the interface template and the dynamic service parameters to perform API parameter replacement and calculation to form a calling example; step S5: the calling instance calls an external system and outputs events through a calling driver;
the metadata definition comprises an API name, an API code, an API description, a connection protocol, a request URL and method and a parameter format, and the parameter template definition and the template variable definition are obtained through a parameter verifier and a parameter converter;
the external system transfer comprises service transfer, test or operator verification transfer and system self-checking automatic verification transfer, and the event output comprises notification and alarm output;
the method comprises the steps that during visual testing, an API selected for testing displays basic information, request information and error information of the API through a system interface, and the visualization of a function verification process and a result is achieved;
the method comprises the following steps that life cycle management needs to be carried out on each API, and API cycle states comprise four states, namely a draft state which is not defined yet, a test state which can be used for testing, a release state which is released to a production environment and can be loaded dynamically, and a down state which is not used any more by the API;
the API control module processes the API request and comprises white list control, API flow control and API route control, the white list limits the appointed host computer to be able to access the system, the API flow control supports the system to limit the API access frequency, the API is limited, too fast information impacts the system, and the API route control refers to how to process the API request.
2. A system based on the API gateway management method of claim 1, characterized in that: the system comprises an access module, a service gateway and a service gateway, wherein the access module is used for accessing a plurality of service systems into an API gateway; the system monitoring module is used for monitoring the use state of the system; the API management module is used for defining, viewing, modifying, converting the API into a template, verifying parameters, binding and converting, visually testing and managing the life cycle of the API; the API log module comprises an API management operation log, an API request log and an API route log; an API control module for processing API requests; a system management module for validator and translator management and parameter configuration.
3. The system of claim 2, wherein the API gateway management method comprises: the system monitoring module monitors measurement, threads, components, health and environment information, wherein the measurement comprises the operating memory utilization rate, and the operating memory utilization rate displays the used memory, the residual memory and the use ratio of each part through a ratio disk.
4. The system of claim 3, wherein the API gateway management method comprises: API definition, in the API definition list, the API definition can be dynamically created, deleted, modified and tested, and the API capability is increased in real time; the API with various protocol isomerism, parameters and format isomerism is converted into a unified API with a specification through a parameter template, an input parameter template comprises one or more API parameter variables, the variables are dynamically bound with a plurality of verifiers, and an up parameter variable sets a verification and verification rule in a lower parameter list; similarly, the output parameters also define the template, the template variables bind with the converter, the downlink parameter variables set the conversion rules in the parameter list below, and various API parameters are solidified and customized privately.
5. The system of claim 4, wherein the API gateway management method comprises: the parameter verification and conversion converts the templated API into a standardized API for convenient calling by a user, each parameter is provided with a plurality of verifiers or converters, and the verifiers comprise a null parameter verifier for verifying whether the parameter is null, a repeated request verifier for verifying whether the parameter is repeated in a specified time range, a digital verifier for verifying whether the parameter is all numbers or not, a letter verifier for verifying whether the energy number is all letters or not, a digital letter verifier for verifying whether the parameter is all numbers or letters, a URL verifier for verifying whether the parameter is legal URL address, a minimum length verifier for verifying whether the parameter length is less than a specified length, a maximum length verifier for verifying whether the energy number length is greater than a specified length, an XML format verifier for verifying whether the parameter is legal XML data, a JSON format verifier for verifying whether the parameter is legal JSON data, a Base64 coding verifier for verifying whether the parameter is legal Base64 verifier for a legal Base64 verifier for verifying whether the parameter is legal, a time stamp verifier for verifying whether the time parameter is in a specified time difference range, an IP verifier for verifying whether the IP address is legal identifier and a unique identifier for verifying whether the time difference is a unique identifier, the converter comprises a universal converter, an encryption/decryption converter, a format converter and a private converter, wherein the universal converter comprises a serial number generation converter, a timestamp generation converter, a dictionary sequence signature converter, a time format escape converter, a time formatting converter, a parameter connection converter and a numerical value converter; the encryption and decryption converter comprises an MD5 signature converter, an SHA1 encryption converter, an RSA encryption converter, a Base64 converter and an RSA + Base64 converter; the format converter comprises an XML format converter and a JSON format converter; the private translator is a custom type translator.
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201811350232.4A CN109460223B (en) | 2018-11-14 | 2018-11-14 | API gateway management system and method thereof |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201811350232.4A CN109460223B (en) | 2018-11-14 | 2018-11-14 | API gateway management system and method thereof |
Publications (2)
| Publication Number | Publication Date |
|---|---|
| CN109460223A CN109460223A (en) | 2019-03-12 |
| CN109460223B true CN109460223B (en) | 2022-11-25 |
Family
ID=65610273
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN201811350232.4A Active CN109460223B (en) | 2018-11-14 | 2018-11-14 | API gateway management system and method thereof |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN109460223B (en) |
Families Citing this family (11)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN110113394A (en) * | 2019-04-19 | 2019-08-09 | 浙江数链科技有限公司 | API Calls method and apparatus |
| CN110602043A (en) * | 2019-08-08 | 2019-12-20 | 中腾信金融信息服务(上海)有限公司 | API gateway implementation system and method for mobile application |
| CN110502508A (en) * | 2019-08-23 | 2019-11-26 | 行吟信息科技（上海）有限公司 | A kind of method of calibration and system based on dynamic state of parameters |
| CN110753127A (en) * | 2019-10-29 | 2020-02-04 | 浪潮云信息技术有限公司 | Method for realizing request parameter conversion based on Kong API gateway |
| CN111125594A (en) * | 2019-12-04 | 2020-05-08 | 深圳晶泰科技有限公司 | Method and system for managing a large number of task input parameters in distributed system |
| WO2021109027A1 (en) * | 2019-12-04 | 2021-06-10 | 深圳晶泰科技有限公司 | Method and system for managing large number of task input parameters in distributed system |
| CN111064722B (en) * | 2019-12-12 | 2022-10-25 | 山西云时代技术有限公司 | Data sharing method for realizing protocol conversion of set in API mode |
| CN111277499A (en) * | 2020-01-14 | 2020-06-12 | 浙江华云信息科技有限公司 | Gateway-based real-time effective dynamic routing method |
| CN111985186A (en) * | 2020-08-26 | 2020-11-24 | 平安国际智慧城市科技股份有限公司 | Dictionary entry conversion method, API gateway system, equipment and storage medium |
| CN112019332B (en) * | 2020-08-26 | 2022-11-04 | 平安国际智慧城市科技股份有限公司 | Encryption and decryption method based on micro-service, API gateway system and equipment |
| CN112925666A (en) * | 2021-04-10 | 2021-06-08 | 深圳市今天国际物流技术股份有限公司 | Third-party API integrated management method based on groovy script technology |
Family Cites Families (10)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| AUPR464601A0 (en) * | 2001-04-30 | 2001-05-24 | Commonwealth Of Australia, The | Shapes vector |
| US8713060B2 (en) * | 2009-03-31 | 2014-04-29 | Amazon Technologies, Inc. | Control service for relational data management |
| US10050935B2 (en) * | 2014-07-09 | 2018-08-14 | Shape Security, Inc. | Using individualized APIs to block automated attacks on native apps and/or purposely exposed APIs with forced user interaction |
| CN106296202A (en) * | 2016-08-15 | 2017-01-04 | 沈阳林科信息技术有限公司 | A kind of method of consumer's risk prevention and control in terminal charge payment process |
| CN106330935B (en) * | 2016-08-30 | 2019-09-10 | 上海交通大学 | A kind of detection method for the Wi-Fi that goes fishing |
| CN107786616A (en) * | 2016-08-30 | 2018-03-09 | 江苏蓝创聚联数据与应用研究院有限公司 | Main frame intelligent monitor system based on high in the clouds |
| CN108667866B (en) * | 2017-03-29 | 2020-06-23 | 北京数聚鑫云信息技术有限公司 | Request processing method and device based on API intelligent adaptation |
| CN108415944B (en) * | 2018-01-30 | 2019-03-22 | 长安大学 | Real time computation system and its implementation based on micro services under a kind of traffic environment |
| CN108512748A (en) * | 2018-03-21 | 2018-09-07 | 上海艾融软件股份有限公司 | A kind of implementation method of micro services gateway |
| CN108449417A (en) * | 2018-03-29 | 2018-08-24 | 国信优易数据有限公司 | A kind of service data visitation method and device |
-
2018
- 2018-11-14 CN CN201811350232.4A patent/CN109460223B/en active Active
Also Published As
| Publication number | Publication date |
|---|---|
| CN109460223A (en) | 2019-03-12 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN109460223B (en) | API gateway management system and method thereof | |
| WO2019072110A1 (en) | Method for generating application program, apparatus, system, device, and medium | |
| CN111447103A (en) | Virtual device management system, electronic device, virtual device management method, and medium | |
| CN105052076B (en) | Network element management system and network element management method based on cloud computing | |
| CN108134708B (en) | Method and device for monitoring third-party interface | |
| CN107168749A (en) | A kind of Compilation Method, device, equipment and computer-readable recording medium | |
| CN101795270A (en) | Server control method based on serial port | |
| US10608953B2 (en) | Platform with multiple execution engines | |
| CN112527252B (en) | Applet management method and device, applet platform, electronic equipment and medium | |
| CN109032590B (en) | Configuration method, device, terminal and storage medium of visual development environment | |
| CN101482817A (en) | Large-particle Java component assembly method based on black box | |
| CN105577463A (en) | Testing method and testing device based on communication protocol | |
| CN113505520A (en) | Method, device and system for supporting heterogeneous federated learning | |
| CN110674083A (en) | Workflow migration method, device, equipment and computer readable storage medium | |
| CN112631590A (en) | Component library generation method and device, electronic equipment and computer readable medium | |
| CN111651121A (en) | Data logic calculation method and device, electronic equipment and storage medium | |
| CN109902493B (en) | Script issuing method and server | |
| CN106407061A (en) | Northbound interface testing device and northbound interface testing method | |
| CN107122307B (en) | Internet of things execution system | |
| JP2005228183A (en) | Program execution method and computer system for executing the program | |
| CN103561113A (en) | Web Service interface generating method and device | |
| TW201407503A (en) | System and method for work schedule of cloud platform | |
| CN115460265A (en) | Interface calling method, device, equipment and medium | |
| CN115237399A (en) | Method for collecting data, storage medium, processor and engineering vehicle | |
| JP2010049439A (en) | System construction method using software model and modeling device |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination | ||
| GR01 | Patent grant | ||
| GR01 | Patent grant |