A multi-language unified API management method

Abstract

The present invention discloses a multi-language unified API management method, which belongs to the field of software engineering, wherein the method includes: interactively obtaining a multi-language API specification, the multi-language API specification including an API name, a request method, a request path, request parameters, and a response format; based on the multi-language API specification, creating a multi-language API description file, and mapping it to a multi-language API response matrix; receiving and parsing the API request of the client through an API gateway, and determining the requested target API; according to the description file of the requested target API, traversing the multi-language API response matrix for demand matching, and obtaining the demand matching result; based on the demand matching result, calling the multi-language API, executing the corresponding business response, and returning the data to the client. The present application solves the technical problems in the prior art that the management of multi-language API is complex and error-prone, resulting in low development efficiency and poor consistency.

Description

Technical Field

[0001] The present invention relates to the field of software engineering, and in particular to a multi-language unified API management method. Background Art

[0002] With the development of globalization, software systems need to support multilingual environments to meet the needs of users in different regions. This includes not only multilingual interfaces and content, but also multilingual support for backend services and APIs. For large systems, unified management and calling of multilingual APIs are the key to improving development efficiency and ensuring system consistency.

[0003] Traditional API management requires manual maintenance of the specifications and calling methods of each API, which is inefficient and error-prone, especially in a multi-language environment. Every time the API specification is modified or a new API is added, developers need to manually update the relevant documents and codes, increasing the workload and the risk of errors. APIs in different languages ​​and platforms may use different standards and protocols, which increases the difficulty of cross-platform development. Developers need to understand and adapt to the API specifications of each language, which increases the learning cost.

[0004] In summary, the present application aims to solve the technical problems in the prior art that multi-language API management is complex and error-prone, resulting in low development efficiency and poor consistency. Summary of the invention

[0005] This application provides a multi-language unified API management method, aiming to solve the technical problems in the prior art that multi-language API management is complex and error-prone, resulting in low development efficiency and poor consistency.

[0006] In view of the above problems, the present application provides a multi-language unified API management method.

[0007] The first aspect disclosed in the present application provides a multi-language unified API management method, which includes interactively obtaining a multi-language API specification, wherein the multi-language API specification includes an API name, a request method, a request path, request parameters, and a response format; based on the multi-language API specification, creating a multi-language API description file, and mapping it to a multi-language API response matrix; receiving and parsing the API request of the client through an API gateway, and determining the request target API; according to the description file of the request target API, traversing the multi-language API response matrix to perform demand matching and obtain a demand matching result; based on the demand matching result, calling the multi-language API, executing a corresponding business response, and returning data to the client.

[0008] One or more technical solutions provided in this application have at least the following technical effects or advantages:

[0009] Since multilingual API specifications are obtained through interaction, these specifications include API name, request method, request path, request parameters and response format. Based on these specifications, a multilingual API description file is created and mapped to a multilingual API response matrix. The system receives and parses the client's API request through the API gateway to determine the target API of the request. According to the description file of the target API, the multilingual API response matrix is ​​traversed to match the requirements and obtain the requirement matching results. Based on the requirement matching results, the corresponding multilingual API is called, the relevant business logic is executed, and the data is returned to the client. The technical problems in the prior art that multilingual API management is complex and error-prone, resulting in low development efficiency and poor consistency, are solved, the compatibility and efficiency of the system are improved, and client requests are ensured to be responded to quickly and accurately.

[0010] The above description is only an overview of the technical solution of the present application. In order to more clearly understand the technical means of the present application, it can be implemented according to the contents of the specification, and in order to make the above and other purposes, features and advantages of the present application more obvious and easy to understand, the specific implementation methods of the present application are specifically cited below. It should be understood that the content described in this section is not intended to identify the key or important features of the embodiments of the present application, nor is it intended to limit the scope of the present application. Other features of the present application will become easy to understand through the following description. BRIEF DESCRIPTION OF THE DRAWINGS

[0011] Figure 1 A flowchart of a multi-language unified API management method is provided for an embodiment of the present application;

[0012] Figure 2 A flowchart of obtaining demand matching results in a multi-language unified API management method is provided for an embodiment of the present application; DETAILED DESCRIPTION

[0013] The overall idea of ​​the technical solution provided by this application is as follows:

[0014] An embodiment of the present application provides a multi-language unified API management method. First, the system interacts to obtain multi-language API specifications, which include detailed information such as API name, request method, request path, request parameters, and response format. Based on these specifications, a multi-language API description file is created and mapped to a multi-language API response matrix for unified management and calling. Next, the API gateway receives and parses the client's API request to determine the target API of the request. Then, according to the description file of the target API, the multi-language API response matrix is ​​traversed to perform demand matching, find the API response that best meets the request requirements, and obtain the demand matching results. Finally, based on the demand matching results, the corresponding multi-language API is called, the relevant business logic is executed, and the processing results are returned to the client.

[0015] After introducing the basic principles of the present application, various non-limiting implementation methods of the present application will be specifically described below in conjunction with the drawings in the specification.

[0016] Example

[0017] like Figure 1 As shown, the embodiment of the present application provides a multi-language unified API management method, the method comprising:

[0018] Step S100: interactively obtain a multi-language API specification, wherein the multi-language API specification includes an API name, a request method, a request path, request parameters, and a response format.

[0019] Specifically, interactive acquisition refers to obtaining the specification information of multilingual APIs through interactive methods (such as user interfaces, API calls, or other methods). The "interactive" here means that this process is dynamic and operational, involving interactions with developers, systems, or other interfaces. Multilingual API specifications refer to the specifications and definitions of APIs in different programming language environments. These specifications include various important properties and usage methods of APIs.

[0020] Among them, the multilingual API specification includes API name, request method, request path, request parameters and response format. The API name refers to the identification name of the API, which is used to distinguish and call a specific API. The request method refers to the HTTP request method, such as GET, POST, PUT, DELETE, etc., which specifies the calling method of the API. The request path refers to the URL path, which is used to locate the specific resources or operations of the API. The request parameters refer to the parameters required when calling the API, including query parameters, path parameters, and request body parameters. The response format refers to the data format returned after the API call, such as JSON, XML, etc., which describes the data structure and content of the response.

[0021] This step ensures that the system has complete and accurate API information by interactively obtaining multilingual API specifications, providing reliable data support for subsequent automated management and calls.

[0022] Step S200: Based on the multilingual API specification, a multilingual API description file is created and mapped into a multilingual API response matrix.

[0023] Specifically, based on the multilingual API specifications (including API name, request method, request path, request parameters and response format) obtained in step S100, the multilingual API specifications are converted into a structured description file. These description files record the specifications and properties of each API in detail, making API information easier to manage and use.

[0024] Then, the API description file is converted into a matrix form. The response matrix is ​​a structured data format used to represent the response format and content of different APIs. Each cell of the response matrix may contain the response format of a specific API call and its corresponding field mapping relationship. This enables the system to uniformly manage and call APIs in different languages ​​to ensure consistency and compatibility.

[0025] This step creates a multi-language API description file and maps it to a response matrix. The system can efficiently manage multi-language APIs and ensure that different response formats and contents can be correctly parsed and processed when calling the API, thereby improving the compatibility and consistency of the system.

[0026] Step S300: Receive and parse the API request from the client through the API gateway to determine the requested target API.

[0027] Specifically, the API gateway is an intermediate layer between the client and the server, which acts as the entry point for all API requests. The API gateway can not only route requests, but also handle functions such as authentication, current limiting, logging, and load balancing. The API request is received from the client through the API gateway and the content of the request is parsed. The parsing process includes extracting various parameters of the request, such as the request path, request method, and request parameters. After parsing the request, the API gateway determines the target API based on the content of the request. This includes matching the specific API based on the request path and request method, so as to know which API the client is requesting.

[0028] This step receives and parses the client's API request through the API gateway and determines the target API of the request, which can improve the efficiency and accuracy of request processing. This centralized management method helps to simplify the system architecture and enhance the scalability and security of the system.

[0029] Step S400: According to the description file of the requested target API, the multi-language API response matrix is ​​traversed to perform demand matching and obtain demand matching results.

[0030] Specifically, it relies on the multilingual API description file that has been created, which records in detail the various specifications and properties of the target API. The multilingual API response matrix is ​​a structured data format used to represent the response format and content of different APIs. Among them, traversing the multilingual API response matrix means checking and comparing each API response entry in the matrix. The demand matching refers to comparing the client's request requirements with the entries in the API response matrix to find the API response that best meets the request requirements. The matching process includes checking request parameters, response formats and other relevant information.

[0031] Through traversal and matching, the system will eventually obtain one or more API response entries that meet the request requirements. These matching results are the final output of the requirement matching, and the system will perform subsequent operations based on these results.

[0032] This step traverses the multi-language API response matrix to match the requirements and obtain the matching results according to the description file of the requested target API, which can ensure that the system can accurately find the API response that best meets the request requirements and provide accurate services. This method improves the flexibility and response accuracy of the system, making API management and calling more efficient and reliable.

[0033] Step S500: Based on the demand matching result, call the multi-language API, execute the corresponding business response, and return data to the client.

[0034] Specifically, based on the requirements matching results, these matching results determine the API response that best meets the request requirements. Based on the requirements matching results, the system will call the corresponding multilingual API. This step is to put the matching results into practice and actually issue an API call request. After calling the API, the system executes the corresponding business logic based on the API response. This may include processing the response data, performing calculations, or other specific business operations. Finally, the system returns the processed results or response data to the client. This process ensures that the client can obtain the expected results and complete the entire request-response cycle.

[0035] This step ensures that the system can correctly and effectively process client requests and provide accurate responses by calling the multilingual API based on the demand matching results, executing the corresponding business response, and returning data to the client. This process improves the system's responsiveness and customer satisfaction, and ensures efficient management and use of multilingual APIs.

[0036] Furthermore, the method further comprises:

[0037] The multi-language API specification also includes API version information and document description; based on the preset update constraints and in combination with the API version information, the multi-language API specification is updated and acquired.

[0038] Specifically, in addition to the API name, request method, request path, request parameters, and response format, the API specification also includes version information and documentation. The API version information indicates the specific version of the API, helping to track API changes and compatibility issues. The documentation describes the API's functions, usage methods, parameter descriptions, examples, etc. in detail to provide guidance for developers.

[0039] The update constraints are pre-set rules or conditions used to control and manage the update process of the API specification. These constraints may include update frequency, update timing, compatibility check, etc.

[0040] When updating the API specification, the system will combine the API version information to ensure that the latest and compatible API version is obtained. The update acquisition process is dynamic, and the system automatically or semi-automatically obtains and updates the API specification according to the preset constraints.

[0041] This step includes API version information and documentation, as well as updating the API specification based on preset update constraints, to ensure that the system always uses the latest and most accurate API specification, improving the stability and reliability of the system. This process helps maintain API consistency and compatibility, simplify API management, and improve development efficiency.

[0042] Furthermore, the method further comprises:

[0043] Based on the multilingual API description file, define a multilingual response format mapping; configure a standard response format, and based on the multilingual response format mapping, specify a standardized response format conversion rule; define a mapping relationship between multilingual response fields and standardized fields, and create a multilingual field mapping table; integrate the multilingual response format mapping, the standardized response format conversion rule, and the multilingual field mapping table, and output the multilingual API response matrix.

[0044] Specifically, according to the created multi-language API description file, the response format mapping relationships of APIs in different languages ​​are defined. These mapping relationships describe the specific format and structure of each API response.

[0045] Configure a standard response format, which is a reference for unifying API response formats in different languages. According to the multi-language response format mapping, specify conversion rules to convert API response formats in different languages ​​into the standard response format. These conversion rules describe in detail how to standardize different response formats.

[0046] Define the mapping relationship between each multilingual API response field and the standardized field. This step ensures that each API response field has a corresponding standardized field. Create a mapping table to record the mapping relationship between all multilingual API response fields and standardized fields. This mapping table is the basis for subsequent standardized conversion.

[0047] Integrate the defined multi-language response format mapping, standardized response format conversion rules, and multi-language field mapping tables. Finally, a multi-language API response matrix is ​​output, which integrates the response formats and field mapping relationships of all APIs and provides a unified view to manage and call APIs in different languages.

[0048] Through this step, the system can uniformly manage and call API responses in different languages, ensuring the consistency and compatibility of the response format. This process improves the efficiency and accuracy of API management and makes multi-language API calls simpler and more reliable.

[0049] Furthermore, the method further comprises:

[0050] Based on the description file of the requested target API, a target API name is obtained; according to the target API name, identical matching is performed in the multi-language API response matrix to obtain an identical matching result; and the identical matching result is output as the demand matching result.

[0051] Specifically, the name of the target API is extracted from the description file of the requested target API for matching in subsequent steps.

[0052] Use the target API name to perform an identical match in the multilingual API response matrix. The identical match is based on the consistency of the name, that is, to find the API response entry with the same name as the target API. Through the identical match process, the system will find all API response entries with the same name as the target API, and these entries constitute the identical match result.

[0053] The same matching results found are output as the final demand matching results. These results will be used for subsequent API calls and business response execution.

[0054] In this step, the system can ensure that the API response that is consistent with the requested target API is found accurately through the same matching, and provide the correct service. This can improve the accuracy and reliability of API calls and ensure that the system can correctly process and respond to client requests.

[0055] Furthermore, the method further comprises:

[0056] If the same matching result is displayed as empty, then based on the description file of the requested target API, extract the target request parameters and target response format; perform 1PASS equivalent matching according to the target response format; based on the 1PASS equivalent matching result, perform 2PASS equivalent matching according to the target request parameters to obtain a 2PASS equivalent matching result, wherein the 2PASS equivalent matching result is a serialized plurality of equivalent APIs; select the best of the 2PASS equivalent matching results and output the demand matching result.

[0057] Specifically, in the same matching process, if no API response entry with the same name as the target API is found, the request parameters and response format information are extracted from the description file of the target API. This information will be used in further matching processes.

[0058] 1PASS equality matching refers to preliminary matching based on the response format of the target API, looking for API response entries with the same or similar response format. This step mainly focuses on matching the response format.

[0059] Based on the 1PASS matching results, 2PASS matching is further performed based on the request parameters of the target API. This step focuses on matching request parameters to find more precise equivalent API response entries. Get 2PASS equivalent matching results, which are multiple API response entries with similar response formats and request parameters to the target API. These matching results are serialized, which means they are organized into an ordered list for further processing and selection.

[0060] The 2PASS matching results are prioritized and the API response items that best meet the requirements are selected. Finally, the requirement matching results are output, which will be used for subsequent API calls and business response executions.

[0061] Through this extended matching process, the system can still find the most suitable API response through multiple matching and optimization when the same matching fails, ensuring the flexibility and reliability of the system. It improves the adaptability of API management and calling, and can better meet the complex multi-language API calling requirements.

[0062] Furthermore, the method further comprises:

[0063] Activate the API gateway to obtain a call data set of the multilingual API;

[0064] Calculating a call margin set according to the call data set and in combination with the call constraints of the multi-language API, wherein the call constraints include a call frequency constraint and a call period constraint;

[0065] Based on the call margin set, load balancing scheduling of the multi-language API is performed.

[0066] Specifically, the API gateway is started to collect the call data of multilingual APIs through the API gateway. These data include detailed information such as the frequency, time, parameters, and response time of API calls.

[0067] Analyze the collected call data and perform calculations based on the preset call constraints. The call constraints include: call frequency constraints, which limit the number of API calls within a certain period of time to prevent overload; call cycle constraints, which limit the number of API calls within a specific period to ensure fair use and resource allocation. Then calculate the call margin set, which is an indicator for measuring the API call load, indicating the API call load and available margin under the current constraints.

[0068] Load balancing is performed based on the calculated call margin set. Load balancing is to reasonably distribute API call requests to different servers or instances to optimize resource usage and ensure system stability and efficiency.

[0069] This step activates the API gateway to obtain call data, calculates the call margin based on the call constraints, and performs load balancing scheduling based on this, which can effectively manage and optimize the call load of multi-language APIs. This process improves the efficiency and stability of the system and ensures that API calls can still maintain good performance under high load conditions.

[0070] Furthermore, the method further comprises:

[0071] Statistically analyzing the call data set to obtain first call frequency data and first period call frequency data; performing margin calculation based on the call frequency constraint and the call period constraint in combination with the first call frequency data and the first period call frequency data to obtain a first margin coefficient; traversing the call data set to calculate and obtain the margin set.

[0072] Specifically, the collected call data is statistically analyzed to obtain detailed information about the API calls, including: first call frequency data, which indicates the number of times the API is called per unit time; first period call frequency data, which indicates the number of times the API is called within a specific period.

[0073] According to the preset call frequency constraint and call cycle constraint, the collected call data is subjected to margin calculation. The margin calculation refers to evaluating the gap between the current call frequency and the periodic call frequency and the set constraints to determine the call margin of the API. The first margin coefficient refers to the calculation result indicating the available margin of the API under the current constraint conditions.

[0074] Finally, all call data are traversed, and margin calculation is performed on each data point to obtain a complete call margin set. The margin set contains margin information of all API calls and is used for subsequent load balancing scheduling.

[0075] This step obtains the margin coefficient and margin set of API calls through detailed statistical analysis and margin calculation of call data, which can provide a scientific basis for load balancing scheduling. This process ensures that API calls can run efficiently and stably while meeting the constraints, optimizes system resource usage, and improves overall performance.

[0076] Furthermore, the method further comprises:

[0077] If the demand matching result is the same matching result, the multilingual API is directly called; if the demand matching result is an equivalent matching result, the request parameters of the API request are converted into the language format of the equivalent matching result, and the multilingual API is called to execute the corresponding business response.

[0078] Specifically, based on the demand matching results, the multilingual API is actually called, the business logic is executed, and the results are returned to the client. If the demand matching result shows that the requested API name is completely matched (same match result), the system directly calls the API. The same match result means that the requested API is exactly the same as the API name and specification recorded in the system, without the need for additional conversion or adjustment.

[0079] If the requirement matching result indicates that the requested API is an equivalent match result, the system needs to convert the request parameters. An equivalent match result means that the found API has the same functionality as the requested API, but there may be differences in language or format. Convert the API request parameters to the language format of the equivalent match result to ensure that the called API can correctly understand and process the request. Call the converted API, execute the corresponding business logic, and return the result to the client.

[0080] This step calls the multi-language API according to the demand matching results and distinguishes between the same match and the equivalent match. The system can flexibly and efficiently process API requests to ensure that the requests are responded to correctly. This process enhances the system's ability to manage multi-language APIs and improves the accuracy and reliability of API calls.

[0081] In summary, the multi-language unified API management method provided by the embodiment of the present application has the following technical effects:

[0082] 1. Obtain multi-language API specifications through interaction, create description files and response matrices, receive and parse client requests through the API gateway, call multi-language APIs after matching requirements, execute corresponding business responses and return data. This can uniformly manage and call APIs in different languages, reduce the complexity of development and maintenance, improve system compatibility and efficiency, and ensure that client requests are responded to quickly and accurately.

[0083] 2. Incorporate API version information and documentation into multilingual API specifications, and update and obtain specifications based on preset update constraints to ensure that the system can update API specifications in a timely manner, maintain consistency with the latest API version, reduce compatibility issues caused by API updates, ensure the accuracy and real-time nature of API management, and improve system maintenance efficiency.

[0084] 3. According to the description file of the requested target API, the target API name is obtained and the same match is performed in the multi-language API response matrix, and the same matching result is output as the demand matching result. This step ensures that the system can quickly find the API response that fully matches the request, reduces the complexity and time of the matching process, and improves the system response speed and accuracy.

[0085] 4. Directly call the multi-language API according to the matching results or call the API after converting the request parameters when the matching results are equal, execute the corresponding business response and return data. This method ensures the flexibility and accuracy of API calls, adapts to the API requirements of different languages ​​through parameter conversion, improves the compatibility and responsiveness of the system, and ensures the consistency and efficiency of business processing.

[0086] Any step of the method described above can be stored as a computer instruction or program in an unlimited computer memory, and can be called and recognized by an unlimited computer processor to implement any method in the embodiments of the present application, without any unnecessary restrictions.

[0087] Furthermore, the first or second mentioned above may represent an order relationship, or may represent a specific concept, and / or may refer to multiple elements that can be selected individually or in full. Obviously, those skilled in the art may make various changes and modifications to the present application without departing from the scope of the present application. Thus, if these modifications and variations of the present application fall within the scope of the present application and its equivalents, the present application intends to include these modifications and variations.

Claims

1. A multi-language unified API management method, characterized in that: The method comprises: Interactively obtain a multi-language API specification, wherein the multi-language API specification includes an API name, a request method, a request path, request parameters, and a response format; Based on the multilingual API specification, create a multilingual API description file and map it into a multilingual API response matrix; Through the API gateway, receive and parse the client's API request and determine the target API of the request; According to the description file of the requested target API, traverse the multilingual API response matrix to perform demand matching and obtain demand matching results; Based on the demand matching result, the multilingual API is called, the corresponding business response is executed, and the data is returned to the client.

2. A multi-language unified API management method as claimed in claim 1, characterized in that: The multi-language API specification also includes API version information and document description; based on the preset update constraints and in combination with the API version information, the multi-language API specification is updated and acquired.

3. A multi-language unified API management method as claimed in claim 1, characterized in that: Mapping to a multi-language API response matrix, the method includes: Based on the multilingual API description file, define a multilingual response format mapping; configuring a standard response format, and specifying a standardized response format conversion rule based on the multi-language response format mapping; Define the mapping relationship between multilingual response fields and standardized fields, and create a multilingual field mapping table; The multi-language response format mapping, the standardized response format conversion rules, and the multi-language field mapping table are integrated to output the multi-language API response matrix.

4. A multi-language unified API management method as claimed in claim 3, characterized in that: According to the description file of the requested target API, traversing the multi-language API response matrix to perform demand matching and obtain demand matching results, the method includes: Based on the description file of the requested target API, obtain the target API name; According to the target API name, perform the same match in the multi-language API response matrix to obtain the same match result; The same matching result is output as the requirement matching result.

5. A multi-language unified API management method as claimed in claim 4, characterized in that: The method further comprises: If the same matching result is displayed as empty, then based on the description file of the requested target API, extract the target request parameters and the target response format; Perform 1PASS equality matching according to the target response format; Based on the 1PASS equivalent matching result, perform 2PASS equivalent matching according to the target request parameter to obtain a 2PASS equivalent matching result, wherein the 2PASS equivalent matching result is a serialized plurality of equivalent APIs; The 2PASS equivalent matching results are selected based on merit, and the requirement matching results are output.

6. A multi-language unified API management method as claimed in claim 1, characterized in that: The method comprises: Activate the API gateway to obtain a call data set of the multilingual API; Calculating a call margin set according to the call data set and in combination with the call constraints of the multi-language API, wherein the call constraints include a call frequency constraint and a call period constraint; Based on the call margin set, load balancing scheduling of the multi-language API is performed.

7. A multi-language unified API management method as claimed in claim 6, characterized in that: Calculating a call margin set based on the call data set and in combination with the call constraints of the multi-language API, the method further includes: Statistically analyzing the call data set to obtain first call frequency data and first period call frequency data; Based on the calling frequency constraint and the calling period constraint, a margin calculation is performed in combination with the first calling frequency data and the first period calling frequency data to obtain a first margin coefficient; The calling data set is traversed to obtain the margin set by calculation.

8. A multi-language unified API management method as claimed in claim 5, characterized in that: Based on the demand matching result, calling the multilingual API, executing a corresponding business response, and returning data to the client, the method further includes: If the requirement matching result is the same matching result, directly calling the multilingual API; If the requirement matching result is an equivalent matching result, the request parameters of the API request are converted into the language format of the equivalent matching result, and the multilingual API is called to execute a corresponding business response.

Images