Lightweight enterprise application interconnection interface system based on digital basic platform

By adopting a lightweight enterprise application interconnection interface system based on a digital basic platform in an enterprise environment, combined with RESTful API, OAuth2, JWT and containerization technology, the problem of weak interaction between information silos and systems is solved, and rapid deployment and efficient implementation are achieved. The interface security and system flexibility have improved the enterprise's digital transformation capabilities.

CN119203114APending Publication Date: 2024-12-27STATE GRID INFO TELECOM GREAT POWER SCI & TECH
View PDF 5 Cites 0 Cited by

Patent Information

Application Number
CN202411314260.6
Authority / Receiving Office
CN · China
Patent Type
Applications(China)
Current Assignee / Owner
Filing Date
2024-09-20
Publication Date
2024-12-27

AI Technical Summary

Technical Problem

There are information island effect, weak inter-system interaction and high integration problems in the enterprise environment, resulting in inefficient information sharing and system collaboration.

Method used

Adopt a lightweight enterprise application interconnection interface system based on a digital basic platform, combining the RESTful API through API Gateway module, authentication and authorization module, microservice architecture, containerization and cluster management module, API life cycle management module, adapter and integration module , OAuth2, JWT, Docker and Kubernetes technologies to achieve cross-platform compatibility, security, elastic scaling and high availability.

Benefits of technology

It has achieved rapid deployment and configuration, cross-platform compatibility, interface security and system flexibility, significantly improved the digital transformation and market response capabilities of enterprises, and reduced integration and maintenance costs.

✦ Generated by Eureka AI based on patent content.

Smart Images

  • Figure CN119203114A_ABST
    Figure CN119203114A_ABST
Patent Text Reader

Abstract

The invention relates to the technical field of digital platforms, and discloses a lightweight enterprise application interconnection interface system based on a digital basic platform, comprising an API Gateway module which is used as a system entrance and is responsible for requesting routing, load balancing and security control to ensure cross-platform compatibility; and the authentication and authorization module adopts OAuth2 and JWT to guarantee interface security, processes user authentication and authority distribution, and prevents unauthorized access. Through lightweight and highly modular design, enterprises are allowed to quickly deploy and configure, large-scale transformation on existing IT infrastructures is not needed, including adopting a RESTful API design principle to ensure cross-platform compatibility and utilizing standard protocols such as OAuth2 and JWT to ensure interface security, and the method has the advantages of high reliability, high reliability and high reliability. And through a containerization technology and Kubernetes cluster management, elastic scaling and high-availability deployment are realized.
Need to check novelty before this filing date? Find Prior Art

Description

Technical Field

[0001] The present invention relates to the field of digital platforms, and more specifically, to a lightweight enterprise application interconnection interface system based on a digital basic platform. Background Art

[0002] Faced with the information island effect, weak interactivity between systems and high integration costs that are prevalent in the current enterprise environment.

[0003] Therefore, an innovative solution was proposed, which relies on a digital infrastructure platform, adopts microservice architecture and advanced API management technology.

[0004] The design focuses on lightweight and modularity to ensure rapid deployment and configuration capabilities; cross-platform compatibility is ensured through RESTful API, interface security is enhanced using OAuth2 and JWT, and system elasticity and high availability are achieved by combining Docker and Kubernetes.

[0005] In addition, the integrated API full lifecycle management greatly improves the efficiency of development and operation and maintenance. The actual case proves that the system can significantly promote the digital transformation of enterprises and enhance market responsiveness. In the future, the research direction will explore the application of AI and machine learning technology in the intelligent level of the system to continuously promote technological innovation. Summary of the invention

[0006] The present invention provides a lightweight enterprise application interconnection interface system based on a digital basic platform, which solves the technical problems of information island effect, weak interactivity between systems and high cost of integration in related technologies.

[0007] The present invention provides a lightweight enterprise application interconnection interface system based on a digital basic platform, comprising:

[0008] API Gateway module: As the system entrance, it is responsible for request routing, load balancing and security control to ensure cross-platform compatibility;

[0009] Execute step S100 through the API Gateway module to design the communication protocol between services and determine the data interaction format;

[0010] Authentication and authorization module: uses OAuth2 and JWT to ensure interface security, handle user authentication and permission allocation, and prevent unauthorized access;

[0011] Execute step S200 through the authentication and authorization module, deploy the container on the Kubernetes cluster, and configure the automatic scaling policy, health check and fault tolerance mechanism;

[0012] Microservice architecture modules: Enhance modularity by splitting the system into small, independent microservices that can be independently developed, deployed, and scaled;

[0013] Execute step S300 through the microservice architecture module, configure the API Gateway, integrate the authentication and authorization modules, and use OAuth2 and JWT to ensure the security of all API calls;

[0014] Containerization and cluster management module: Use Docker to realize service containerization, and combine Kubernetes to automate deployment and management;

[0015] Execute step S400 through the containerization and cluster management module, design and implement the user authentication process, use the OAuth2 protocol to manage third-party application access rights, and use JWT to pass security tokens;

[0016] API lifecycle management module: covers the full-cycle management of APIs from design to retirement, including documentation, testing, monitoring, and performance optimization;

[0017] Execute step S500 through the API lifecycle management module, introduce API design tools, and automate document generation; deploy a test environment and implement a continuous integration / continuous deployment (CI / CD) process; establish a monitoring and log system, and perform performance analysis and optimization regularly;

[0018] Adapters and integration modules: Provide adapters to seamlessly connect various legacy systems, simplify the integration process of internal enterprise systems, and accelerate digital transformation;

[0019] Step S600 is executed through the adapter and integration module to develop or select ready-made adapters to handle protocol conversion and data mapping between different systems, thereby achieving seamless integration of legacy systems and microservice architecture.

[0020] Furthermore, in step S100, the following steps are also included:

[0021] Step 110: Use nouns to express resources, verbs to map HTTP methods, and construct API paths;

[0022] Step 120: Use of standardized HTTP status codes to ensure response consistency;

[0023] Step 130: Use JSON as a standard data exchange format and follow certain data model design principles to simplify the data processing process;

[0024] Step 140: By introducing a version management mechanism in the API;

[0025] Step 150: Implement HTTPS encryption, authentication mechanism and CORS strategy to prevent data leakage and unauthorized access;

[0026] Step 160: Use Swagger or OpenAPI tools to automate document generation, accelerate the development cycle, and ensure the accuracy and consistency of interface usage.

[0027] Furthermore, in step S200, the following steps are also included:

[0028] Step 210, create a Docker image: encapsulate the application and its dependencies into a Docker image;

[0029] Step 220, write a YAML configuration file to define Pod, Service and Deployment, set container specifications and replication quantity;

[0030] Step 230: Use the kubectl apply command to apply the configuration file to the cluster and start the container application.

[0031] Step 240, setting HPA to automatically adjust the number of Pod replicas based on CPU or memory utilization;

[0032] Step 250, configure Probe to detect the running status of Pod, ensure the health of the service and restart unhealthy instances in time;

[0033] Step 260, using Kubernetes restart strategy, PodDisruptionBudget and StatefulSet to ensure high availability and reduce the impact of single point failure;

[0034] Step 270, integrating monitoring tools and logging systems to facilitate troubleshooting and performance optimization.

[0035] Step 280: Verify the effectiveness of deployment and strategy through traffic testing, and fine-tune scaling parameters and configurations based on actual load conditions.

[0036] Furthermore, in step S300, the following steps are also included:

[0037] Step 310: Select and deploy API Gateway;

[0038] Select the appropriate API Gateway product and install it in the target environment.

[0039] Step 320: Set routing rules to forward specific API requests to corresponding backend services or microservices;

[0040] Step 330: Install and configure the OAuth2 authentication plug-in to add authentication capabilities to the API Gateway;

[0041] Step 340: Configure JWT verification logic to ensure that the API request carries a valid JWT token;

[0042] Step 350: Define roles and permission mappings, and use OAuth2 Scopes to restrict access to specific resources;

[0043] Step 360: Verify whether the authentication and authorization mechanism works as expected by simulating users with different permissions to initiate API requests;

[0044] Step 370: Configure logging and monitoring of API Gateway to track exceptions and performance indicators during the authentication and authorization process;

[0045] Step 380: Write the API Gateway security configuration document.

[0046] Furthermore, in step S400, the following steps are also included:

[0047] Step 401: Select an appropriate OAuth2 authentication process according to the application scenario, such as authorization code mode, implicit authorization, client credentials or password mode;

[0048] Step 402: Deploy and configure an OAuth2 authentication server to manage authentication and authorization as a trusted third party;

[0049] Step 403: Register the client application on the authentication server, obtain the client ID and key, and set the callback URL and required scope;

[0050] Step 404: Design and implement a user login interface, integrate backend logic to handle user credential verification, and support multi-factor authentication for enhanced security;

[0051] Step 405: The front-end application guides the user to the authentication server authorization page. After the user agrees, the server returns an authorization code or access token;

[0052] Step 406: The front-end or back-end application uses the authorization code to request an access token and a refresh token from the authentication server, using HTTPS to ensure secure transmission;

[0053] Step 407: The authentication server issues a JWT, which contains information such as user identification and scope of authority, and sets a validity period and a signature algorithm to ensure that it cannot be tampered with;

[0054] Step 408: Implement JWT verification logic on the API Gateway or microservice end to reject invalid or expired token access and ensure the security of each API call;

[0055] Step 409: Implement token refresh logic. When the access token is about to expire, use the refresh token to automatically obtain a new token to extend the session time.

[0056] Step 410: Record key events and exceptions during the authentication process, and implement monitoring to promptly detect and handle security threats or performance issues;

[0057] Step 411: Regularly review authentication processes and logs to ensure compliance with data protection regulations and perform necessary security updates and hardening measures.

[0058] Furthermore, in step S500, the following steps are included:

[0059] Step 501: Select an API design tool such as Swagger or Postman, integrate it into the development process, automatically generate API documentation and promote standard design;

[0060] Step 502: Automatically synchronize API changes to documents through code comments or configuration files to ensure that the documents are always consistent with the actual interface;

[0061] Step 503: Configure a test environment similar to the production environment, deploy applications and dependent services, and ensure the accuracy and security of the test;

[0062] Step 504: Use Jenkins, GitLab CI / CD, or GitHub Actions tools to automate the code building, testing, and deployment processes.

[0063] Step 505: Write unit tests and integration tests for the API, configure automated test scripts, and incorporate them into the CI / CD process to ensure code quality;

[0064] Step 506: After the automated test is successful, the code is deployed to the pre-production and production environments quickly and reliably through the automatic deployment mechanism;

[0065] Step 507: Deploy log collection and management system

[0066] Integrate ELK Stack or Prometheus+Grafana to centrally collect, store, and analyze logs;

[0067] Step 508: Configure the APM tool to monitor application performance indicators, including response time and throughput.

[0068] Step 509: Based on the monitoring data, regularly perform performance reviews, identify bottlenecks and anomalies, and develop optimization strategies;

[0069] Step 510: Based on the performance analysis results and user feedback, continuously adjust and optimize the code, database query, and resource allocation to improve system performance and stability.

[0070] Furthermore, it is characterized in that, in step S600, the following steps are also included:

[0071] Step 610: Analyze the interface protocols and data structures of the legacy system and the expected interaction mode of the microservice architecture to identify the key conversion requirements that the adapter needs to solve;

[0072] Step 620: Investigate existing adapter tools and services on the market and evaluate their suitability for current needs;

[0073] Step 630: Design an architecture mode of the adapter, such as adopting a middleware mode, a sidecar mode, or a gateway mode;

[0074] Step 640: Develop an adapter component according to specific requirements to implement specific protocol conversion logic and data mapping rules;

[0075] Step 650: Configure or program data field mapping in the adapter to ensure that the legacy system data can be correctly converted into the data model required by the microservice architecture;

[0076] Step 660: Develop code to handle conversions between different communication protocols, such as converting XML messages to JSON format, or adapting to different API standards;

[0077] Step 670: Integrate necessary security measures in the adapter, such as OAuth2 and JWT;

[0078] Step 680: Perform comprehensive unit testing and integration testing to verify data conversion accuracy, protocol conversion functionality, and stability of inter-system communications.

[0079] Furthermore, it is characterized in that it also includes step S700, performing a comprehensive system test, including unit test, integration test and stress test;

[0080] Adjust the configuration based on the test results to optimize performance.

[0081] Furthermore, in step S700, the following contents are also included:

[0082] Unit testing: writing test cases for code modules to verify the behavior of a single function or class to ensure that basic functions are correct;

[0083] Integration testing: Testing the interaction between modules, checking whether the data flow and control flow meet expectations, and ensuring that services work together correctly;

[0084] Stress testing: simulates high-concurrency scenarios, measures the system's performance under extreme conditions, and identifies performance bottlenecks and stability issues;

[0085] Security testing: Conduct penetration testing and vulnerability scanning to verify the security of the system and ensure that data protection and access control mechanisms are effective;

[0086] Performance benchmarking: Establish a performance baseline to quantify system response time, throughput and other indicators to provide a reference for subsequent optimization;

[0087] Test result analysis: Summarize test reports, analyze failure causes, and identify performance shortcomings and potential stability risks;

[0088] Configuration adjustment: Based on test feedback, adjust system configuration, such as resource allocation, cache strategy, thread pool size, etc., to optimize performance;

[0089] Code optimization and refactoring: Optimize bottleneck codes and refactor codes when necessary to improve execution efficiency and maintainability;

[0090] Regression testing: After adjustments and optimizations, re-execute the test suite to verify that the changes have not introduced new issues and ensure overall stability.

[0091] A storage medium storing non-temporary computer-readable instructions for executing one or more modules in the aforementioned lightweight enterprise application interconnection interface system based on a digital basic platform.

[0092] The beneficial effects of the present invention are:

[0093] The present invention uses a lightweight and highly modular design to allow enterprises to quickly deploy and configure without large-scale modifications to existing IT infrastructure, including the use of RESTful API design principles to ensure cross-platform compatibility, the use of standard protocols such as OAuth2 and JWT to ensure interface security, and the use of containerization technology and Kubernetes cluster management to achieve elastic scaling and high-availability deployment. BRIEF DESCRIPTION OF THE DRAWINGS

[0094] Figure 1 It is a flow chart of a method of a lightweight enterprise application interconnection interface based on a digital basic platform of the present invention;

[0095] Figure 2 It is a structural block diagram of a lightweight enterprise application interconnection interface system based on a digital basic platform of the present invention. DETAILED DESCRIPTION

[0096] The subject matter described herein will now be discussed with reference to example embodiments. It should be understood that the discussion of these embodiments is only to enable those skilled in the art to better understand and implement the subject matter described herein, and the functions and arrangements of the elements discussed may be changed without departing from the scope of protection of the contents of this specification. Each example may omit, replace or add various processes or components as needed. In addition, the features described relative to some examples may also be combined in other examples.

[0097] See also Figure 1-Figure 2 As shown, a lightweight enterprise application interconnection interface system based on a digital basic platform includes:

[0098] API Gateway module: As the entrance of the system, it is responsible for receiving all external requests and routing them to the corresponding backend services.

[0099] In one embodiment of the present invention, the RESTful API design principle is adopted to ensure that the interface is concise, stateless and easy to understand, and supports cross-platform calls.

[0100] This module also assumes responsibilities such as load balancing, traffic control, and API version management, and is the key to ensuring high performance and high availability.

[0101] Authentication and authorization module: Integrates standard protocols such as OAuth2 and JSON Web Tokens (JWT) to implement user identity authentication and permission control.

[0102] In one embodiment of the present invention, OAuth2 is used to handle authorization issues when third-party applications access resources, and JWT is used to securely transmit user credential information. The combination of the two ensures the security of interface calls and prevents unauthorized access.

[0103] Microservice architecture module: The system adopts microservice architecture design, which decomposes business logic into a series of small, independent services, each of which focuses on completing a specific function.

[0104] In one embodiment of the present invention, the modularity of the system is improved so that services can be independently developed, deployed and expanded, maintenance costs are reduced, and the flexibility and scalability of the system are enhanced.

[0105] Containerization and cluster management module: Use Docker containerization technology to package applications and their dependencies to achieve standardized deployment.

[0106] In one embodiment of the present invention, the Kubernetes cluster management platform is combined to automatically handle tasks such as service deployment, expansion, and fault recovery to ensure the high availability and elastic scalability of the system.

[0107] This module is the basis for rapid deployment, configuration and dynamic resource management.

[0108] API lifecycle management module: provides full lifecycle management tools from API design, document generation, testing, release to monitoring and analysis.

[0109] In one embodiment of the present invention, developers are supported to quickly create and iterate APIs, while at the same time, through real-time performance monitoring, logging and data analysis, the team is helped to optimize API performance and improve service quality.

[0110] Adapter and integration module: In order to solve the compatibility issues between the legacy system and the new system within the enterprise, this module contains a series of adapters that can connect to systems with different protocols and data formats to achieve smooth integration.

[0111] In one embodiment of the present invention, an enterprise can quickly integrate existing IT assets into a new interconnected system through configuration rather than coding, thereby avoiding large-scale system transformation.

[0112] See also Figure 1 As shown, a method for a lightweight enterprise application interconnection interface based on a digital basic platform includes the following steps:

[0113] Step S100: Planning and designing microservice architecture

[0114] Objective: Identify and define the core business functions in the system and split them into multiple independent microservices. Each microservice should follow the single responsibility principle and focus on completing specific business logic.

[0115] Action: Design the communication protocol between services and determine the data exchange format, such as using the RESTful API design style to ensure cross-platform compatibility.

[0116] In step S100, the following contents are specifically included:

[0117] Step 110: Summary of resource and URL definitions

[0118] Key points: Use nouns to express resources, verbs to map HTTP methods, and build clear and intuitive API paths. This helps developers quickly understand the functions of each service and how to interact with them, while improving the scalability and maintainability of the system.

[0119] Step 120: Status Code and Response Message Summary

[0120] Key points: The use of standardized HTTP status codes ensures response consistency and improves the versatility of client processing logic. The detailed response body design makes error troubleshooting more direct and improves the overall system stability and user experience.

[0121] Step 130: Summary of unified data format

[0122] Key points: Using JSON as the standard data exchange format and following certain data model design principles not only simplifies the data processing process, but also promotes seamless connection between different platforms and services, and enhances interoperability.

[0123] Step 140: Version Control Summary

[0124] Key points: By introducing a version management mechanism into the API, iterative upgrades can be performed without affecting existing services, providing flexibility and stability for the continuous evolution of the system and reducing the risk of service interruption due to changes.

[0125] Step 150: Security Design Summary

[0126] Key points: Implementing HTTPS encryption, authentication mechanism, and CORS strategy builds a solid security line for API communication, effectively preventing data leakage and unauthorized access, and ensuring the security and privacy protection of service interactions.

[0127] Step 160: Documentation Summary

[0128] Key points: Using tools such as Swagger or OpenAPI to automate document generation and provide comprehensive and accurate API reference documentation greatly reduces integration costs, accelerates development cycles, and ensures accuracy and consistency in interface usage. Good documentation is a key factor in API usability and popularity.

[0129] Step S200: Implement containerization and cluster management

[0130] Goal: Use Docker to package each microservice and its dependencies to form a standardized container image.

[0131] Action: Deploy containers on a Kubernetes cluster and configure autoscaling policies, health checks, and fault tolerance mechanisms to ensure high availability and efficient use of resources.

[0132] In step S200, the following contents are specifically included:

[0133] Step 210, create a Docker image: encapsulate the application and its dependencies into a Docker image to achieve standardized construction.

[0134] Step 220, write Kubernetes deployment files: write YAML configuration files to define Pod, Service and Deployment, set container specifications and replication quantity.

[0135] Step 230, deploy the application to the Kubernetes cluster: use the kubectl apply command to apply the configuration file to the cluster and start the container application.

[0136] Step 240, configure Horizontal Pod Autoscaler (HPA): Set HPA to automatically adjust the number of Pod replicas based on CPU or memory utilization to achieve dynamic scaling of resources.

[0137] Step 250, implement health check (Readiness & Liveness Probe): configure Probe to detect the running status of Pod, ensure the health of the service and restart unhealthy instances in time.

[0138] Step 260, set up fault tolerance mechanism and fault recovery strategy: use Kubernetes restart strategy, PodDisruptionBudget and StatefulSet (if applicable) to ensure high availability and reduce the impact of single point failure.

[0139] Step 270, monitoring and log collection: Integrate monitoring tools (such as Prometheus) and log systems (such as Fluentd, Elasticsearch) to facilitate troubleshooting and performance optimization.

[0140] Step 280, verification and adjustment: Verify the effectiveness of deployment and strategy through traffic testing, and fine-tune scaling parameters and configuration according to actual load conditions.

[0141] Step S300: Build API Gateway

[0142] Objective: Establish a unified access point to implement request routing, load balancing, and preliminary security checks.

[0143] Action: Configure API Gateway, integrate authentication and authorization modules, and use OAuth2 and JWT to ensure the security of all API calls.

[0144] Step 310: Select and deploy API Gateway

[0145] Select a suitable API Gateway product (such as Kong, Apigee, Ambassador, etc.) and install it in the target environment.

[0146] Step 320: Configure routing rules

[0147] Set routing rules to forward specific API requests to the corresponding backend services or microservices.

[0148] Step 330: Integrate the authentication plugin

[0149] Install and configure OAuth2 authentication plug-ins, such as Keycloak and OAuth2-Proxy, to add authentication capabilities to API Gateway.

[0150] Step 340: Configure JWT Authentication

[0151] Configure the JWT verification logic to ensure that the API request carries a valid JWT token and can correctly parse and verify the validity of the token.

[0152] Step 350: Design permission control strategy

[0153] Define roles and permission mappings, use OAuth2 Scopes to limit access to specific resources, and implement fine-grained permission management.

[0154] Step 360: Test the authentication and authorization process

[0155] By simulating users with different permissions to initiate API requests, we can verify whether the authentication and authorization mechanism works as expected to ensure security without omissions.

[0156] Step 370: Monitoring and Logging

[0157] Configure API Gateway logging and monitoring to track exceptions and performance metrics during the authentication and authorization process for auditing and troubleshooting.

[0158] Step 380: Documentation and Training

[0159] Write API Gateway security configuration documents and conduct security practice training for developers and operation and maintenance teams to ensure that the team has a deep understanding of security policies.

[0160] Step S400: Integrate authentication and authorization system

[0161] Objective: Implement fine-grained permission control to protect API resources from unauthorized access.

[0162] Action: Design and implement a user authentication process, use OAuth2 protocol to manage access rights to third-party applications, and use JWT to pass security tokens.

[0163] In step S400, the following steps are also included:

[0164] Step 1: Determine the certification type

[0165] Select the appropriate OAuth2 authentication process according to the application scenario, such as authorization code mode, implicit authorization, client credentials or password mode.

[0166] Step 2: Set up the authentication server

[0167] Deploy and configure an OAuth2 authentication server (such as Keycloak, IdentityServer, etc.) as a trusted third party to manage authentication and authorization.

[0168] Step 3: Register the client application

[0169] Register the client application on the authentication server, obtain the client ID and key, and set the callback URL and required scope.

[0170] Step 4: Implement the user login interface and logic

[0171] Designed and implemented user login interface, integrated backend logic to handle user credential verification, and supported multi-factor authentication for enhanced security.

[0172] Step 5: Authorization Request Processing

[0173] The front-end application guides the user to the authentication server authorization page. After the user agrees, the server returns an authorization code or access token.

[0174] Step 6: Exchange the authorization code for a token

[0175] The front-end or back-end application uses the authorization code to request access tokens and refresh tokens from the authentication server, using HTTPS to ensure secure transmission.

[0176] Step 7: Generate a secure token using JWT

[0177] The authentication server issues a JWT, which contains information such as user identification and scope of authority, and sets an expiration date and signature algorithm to ensure that it cannot be tampered with.

[0178] Step 8: Implement JWT Authentication Mechanism

[0179] Implement JWT verification logic on the API Gateway or microservice side to deny access to invalid or expired tokens and ensure the security of each API call.

[0180] Step 9: Refresh Token Management

[0181] Implement token refresh logic. When the access token is about to expire, use the refresh token to automatically obtain a new token to extend the session time.

[0182] Step 10: Logging and Monitoring

[0183] Record key events and exceptions during the authentication process, and implement monitoring to promptly detect and address security threats or performance issues.

[0184] Step 11: Security Audit and Compliance

[0185] Regularly review authentication processes and logs to ensure compliance with data protection regulations (such as GDPR) and implement necessary security updates and hardening measures.

[0186] Step S500: Developing API lifecycle management tools

[0187] Goal: Improve API development efficiency and operation and maintenance quality.

[0188] Action: Introduce API design tools to automate document generation; deploy a test environment and implement a continuous integration / continuous deployment (CI / CD) process; establish a monitoring and logging system and conduct regular performance analysis and optimization.

[0189] In step S500, the following steps are also included:

[0190] Step 501: Select and integrate API design tools

[0191] Choose API design tools such as Swagger or Postman, integrate them into the development process, automatically generate API documentation and promote standardized design.

[0192] Step 502: Automated document generation and maintenance

[0193] Automatically synchronize API changes to documentation through code comments or configuration files to ensure that documentation is always consistent with the actual interface.

[0194] Step 503: Build an isolated test environment

[0195] Configure a test environment similar to the production environment, deploy applications and dependent services, and ensure the accuracy and security of the test.

[0196] Step 504: Configure CI / CD pipeline

[0197] Automate your code building, testing, and deployment processes with tools like Jenkins, GitLab CI / CD, or GitHub Actions.

[0198] Step 505: Write test suites and automate testing

[0199] Write unit tests and integration tests for APIs, configure automated test scripts, and incorporate them into CI / CD processes to ensure code quality.

[0200] Step 506: Implement a continuous deployment strategy

[0201] Through the automatic deployment mechanism after successful automated testing, the code can be deployed to the pre-production and production environments quickly and reliably.

[0202] Step 507: Deploy log collection and management system

[0203] Integrate ELK Stack (Elasticsearch, Logstash, Kibana) or Prometheus+Grafana, etc. to centrally collect, store, and analyze logs.

[0204] Step 508: Establish a performance monitoring system

[0205] Configure APM (Application Performance Monitoring) tools, such as New Relic or Pinpoint, to monitor application performance indicators, including response time, throughput, etc.

[0206] Step 509: Perform regular performance analysis

[0207] Based on monitoring data, regular performance reviews are performed to identify bottlenecks and anomalies and develop optimization strategies.

[0208] Step 510: Continue to optimize and iterate

[0209] Based on performance analysis results and user feedback, we continuously adjust and optimize code, database queries, resource allocation, etc. to improve system performance and stability.

[0210] Step S600: Deploy adapter and integration module

[0211] Goal: Ensure smooth integration between old and new systems.

[0212] Action: Develop or select ready-made adapters to handle protocol conversion and data mapping between different systems to achieve seamless integration of legacy systems and microservice architecture.

[0213] In step S600, the following steps are also included:

[0214] Step 610: Evaluate integration requirements

[0215] Summary: Analyze the interface protocols and data structures of the legacy system and the expected interaction methods of the microservice architecture, and identify the key conversion requirements that the adapter needs to solve.

[0216] Step 620: Research existing solutions

[0217] Summary: Investigate existing adapter tools and services on the market, such as Apache Camel, Spring CloudStream, etc., and evaluate their suitability for current needs.

[0218] Step 630: Design the adapter architecture

[0219] Summary: Design the architecture pattern of the adapter, such as using middleware, sidecar mode or gateway mode, to ensure efficient and flexible data transmission and conversion.

[0220] Step 640: Develop a custom adapter (if no existing adapter is available)

[0221] Summary: According to specific needs, develop adapter components to implement specific protocol conversion logic (such as from SOAP to REST) ​​and data mapping rules.

[0222] Step 650: Configure data mapping rules

[0223] Summary: Configure or program data field mapping in the adapter to ensure that legacy system data can be correctly converted to the data model required by the microservice architecture.

[0224] Step 660: Implementing protocol conversion logic

[0225] Summary: Develop code to handle conversions between different communication protocols, such as converting XML messages to JSON format, or adapting to different API standards.

[0226] Step 670: Integrate security and authentication mechanisms

[0227] Summary: Integrate necessary security measures in the adapter, such as OAuth2 and JWT, to ensure the security and compliance of the data transmission process.

[0228] Step 680: Test Adapter Functionality

[0229] Summary: Conduct comprehensive unit testing and integration testing to verify data conversion accuracy, protocol conversion functionality, and stability of inter-system communications.

[0230] Step S700: Testing and Optimization

[0231] Objective: Ensure the overall performance and stability of the system to meet business needs.

[0232] Action: Conduct comprehensive system testing, including unit testing, integration testing, and stress testing; adjust configuration and optimize performance based on test results.

[0233] In step S700, the following contents are also included:

[0234] Unit testing: Write test cases for code modules to verify the behavior of individual functions or classes and ensure that basic functionality is correct.

[0235] Integration testing: Test the interaction between modules, check whether the data flow and control flow are as expected, and ensure that the services work together correctly.

[0236] Stress testing: simulates high-concurrency scenarios, measures the performance of the system under extreme conditions, and identifies performance bottlenecks and stability issues.

[0237] Security testing: Conduct penetration testing and vulnerability scanning to verify the security of the system and ensure that data protection and access control mechanisms are effective.

[0238] Performance benchmarking: Establish a performance baseline to quantify system response time, throughput and other indicators to provide a reference for subsequent optimization.

[0239] Test result analysis: Summarize test reports, analyze failure causes, and identify performance shortcomings and potential stability risks.

[0240] Configuration adjustment: Based on test feedback, adjust system configuration, such as resource allocation, cache strategy, thread pool size, etc., to optimize performance.

[0241] Code optimization and refactoring: Optimize bottleneck codes and refactor codes when necessary to improve execution efficiency and maintainability.

[0242] Regression testing: After adjustments and optimizations, re-execute the test suite to verify that the changes have not introduced new issues and ensure overall stability.

[0243] At least one embodiment of the present disclosure provides a storage medium storing non-temporary computer-readable instructions for executing one or more modules in the aforementioned lightweight enterprise application interconnection interface system based on a digital basic platform.

[0244] The computer program may be stored / distributed on suitable media, such as optical storage media or solid-state media supplied together with or as part of other hardware, but may also be distributed in other forms, such as via the Internet or other wired or wireless telecommunication systems.

[0245] The above describes an embodiment of the present embodiment, but the present embodiment is not limited to the above-mentioned specific implementation methods. The above-mentioned specific implementation methods are merely illustrative and not restrictive. Under the guidance of the present embodiment, ordinary technicians in this field can also make many forms, all of which are within the protection of the present embodiment.

Claims

1. A lightweight enterprise application interconnection interface system based on a digital basic platform, characterized in that: include: API Gateway module: As the system entrance, it is responsible for request routing, load balancing and security control to ensure cross-platform compatibility; Execute step S100 through the API Gateway module to design the communication protocol between services and determine the data interaction format; Authentication and authorization module: uses OAuth2 and JWT to ensure interface security, handle user authentication and permission allocation, and prevent unauthorized access; Execute step S200 through the authentication and authorization module, deploy the container on the Kubernetes cluster, and configure the automatic scaling policy, health check and fault tolerance mechanism; Microservice architecture modules: Enhance modularity by splitting the system into small, independent microservices that can be independently developed, deployed, and scaled; Execute step S300 through the microservice architecture module, configure the API Gateway, integrate the authentication and authorization modules, and use OAuth2 and JWT to ensure the security of all API calls; Containerization and cluster management module: Use Docker to realize service containerization, and combine Kubernetes to automate deployment and management; Execute step S400 through the containerization and cluster management module, design and implement the user authentication process, use the OAuth2 protocol to manage third-party application access rights, and use JWT to pass security tokens; API lifecycle management module: covers the full-cycle management of APIs from design to retirement, including documentation, testing, monitoring, and performance optimization; Execute step S500 through the API lifecycle management module, introduce API design tools, and automatically generate documents; Deploy test environment and implement continuous integration / continuous deployment (CI / CD) process; establish monitoring and log system, and conduct performance analysis and optimization regularly; Adapters and integration modules: Provide adapters to seamlessly connect various legacy systems, simplify the integration process of internal enterprise systems, and accelerate digital transformation; Step S600 is performed through the adapter and integration module to develop or select ready-made adapters to handle protocol conversion and data mapping between different systems, thereby achieving seamless integration of legacy systems and microservice architecture.

2. According to the lightweight enterprise application interconnection interface system based on the digital basic platform of claim 1, it is characterized in that: In step S100, the following steps are also included: Step 110: Use nouns to express resources, verbs to map HTTP methods, and construct API paths; Step 120: Use of standardized HTTP status codes to ensure response consistency; Step 130: Use JSON as a standard data exchange format and follow certain data model design principles to simplify the data processing process; Step 140: By introducing a version management mechanism in the API; Step 150: Implement HTTPS encryption, authentication mechanism and CORS strategy to prevent data leakage and unauthorized access; Step 160: Use Swagger or OpenAPI tools to automate document generation, accelerate the development cycle, and ensure the accuracy and consistency of interface usage.

3. A lightweight enterprise application interconnection interface system based on a digital basic platform according to claim 2, characterized in that: In step S200, the following steps are also included: Step 210, create a Docker image: encapsulate the application and its dependencies into a Docker image; Step 220, write a YAML configuration file to define Pod, Service and Deployment, set container specifications and replication quantity; Step 230: Use the kubectl apply command to apply the configuration file to the cluster and start the container application. Step 240, setting HPA to automatically adjust the number of Pod replicas based on CPU or memory utilization; Step 250, configure Probe to detect the running status of Pod, ensure the health of the service and restart unhealthy instances in time; Step 260, using Kubernetes restart strategy, PodDisruptionBudget and StatefulSet to ensure high availability and reduce the impact of single point failure; Step 270, integrating monitoring tools and logging systems to facilitate troubleshooting and performance optimization. Step 280: Verify the effectiveness of deployment and strategy through traffic testing, and fine-tune scaling parameters and configurations based on actual load conditions.

4. A lightweight enterprise application interconnection interface system based on a digital basic platform according to claim 3, characterized in that: In step S300, the following steps are also included: Step 310: Select and deploy API Gateway; Select the appropriate API Gateway product and install it in the target environment. Step 320: Set routing rules to forward specific API requests to corresponding backend services or microservices; Step 330: Install and configure the OAuth2 authentication plug-in to add authentication capabilities to the API Gateway; Step 340: Configure JWT verification logic to ensure that the API request carries a valid JWT token; Step 350: Define roles and permission mappings, and use OAuth2 Scopes to restrict access to specific resources; Step 360: Verify whether the authentication and authorization mechanism works as expected by simulating users with different permissions to initiate API requests; Step 370: Configure logging and monitoring of API Gateway to track exceptions and performance indicators during the authentication and authorization process; Step 380: Write the API Gateway security configuration document.

5. A lightweight enterprise application interconnection interface system based on a digital basic platform according to claim 4, characterized in that: In step S400, the following steps are also included: Step 401: Select an appropriate OAuth2 authentication process according to the application scenario, such as authorization code mode, implicit authorization, client credentials or password mode; Step 402: Deploy and configure an OAuth2 authentication server to manage authentication and authorization as a trusted third party; Step 403: Register the client application on the authentication server, obtain the client ID and key, and set the callback URL and required scope; Step 404: Design and implement a user login interface, integrate backend logic to handle user credential verification, and support multi-factor authentication for enhanced security; Step 405: The front-end application guides the user to the authentication server authorization page. After the user agrees, the server returns an authorization code or access token; Step 406: The front-end or back-end application uses the authorization code to request an access token and a refresh token from the authentication server, using HTTPS to ensure secure transmission; Step 407: The authentication server issues a JWT, which contains information such as user identification and scope of authority, and sets a validity period and a signature algorithm to ensure that it cannot be tampered with; Step 408: Implement JWT verification logic on the API Gateway or microservice end to reject invalid or expired token access and ensure the security of each API call; Step 409: Implement token refresh logic. When the access token is about to expire, use the refresh token to automatically obtain a new token to extend the session time. Step 410: Record key events and exceptions during the authentication process, and implement monitoring to promptly detect and handle security threats or performance issues; Step 411: Regularly review authentication processes and logs to ensure compliance with data protection regulations and perform necessary security updates and hardening measures.

6. A lightweight enterprise application interconnection interface system based on a digital basic platform according to claim 5, characterized in that: In step S500, the following steps are included: Step 501: Select an API design tool such as Swagger or Postman, integrate it into the development process, automatically generate API documentation and promote standard design; Step 502: Automatically synchronize API changes to documents through code comments or configuration files to ensure that the documents are always consistent with the actual interface; Step 503: Configure a test environment similar to the production environment, deploy applications and dependent services, and ensure the accuracy and security of the test; Step 504: Use Jenkins, GitLab CI / CD, or GitHub Actions tools to automate the code building, testing, and deployment processes. Step 505: Write unit tests and integration tests for the API, configure automated test scripts, and incorporate them into the CI / CD process to ensure code quality; Step 506: After the automated test is successful, the code is deployed to the pre-production and production environments quickly and reliably through the automatic deployment mechanism; Step 507: Deploy log collection and management system Integrate ELK Stack or Prometheus+Grafana to centrally collect, store, and analyze logs; Step 508: Configure the APM tool to monitor application performance indicators, including response time and throughput. Step 509: Based on the monitoring data, regularly perform performance reviews, identify bottlenecks and anomalies, and develop optimization strategies; Step 510: Based on the performance analysis results and user feedback, continuously adjust and optimize the code, database query, and resource allocation to improve system performance and stability.

7. A lightweight enterprise application interconnection interface system based on a digital basic platform according to claim 6, characterized in that: In step S600, the following steps are also included: Step 610: Analyze the interface protocols and data structures of the legacy system and the expected interaction mode of the microservice architecture to identify the key conversion requirements that the adapter needs to solve; Step 620: Investigate existing adapter tools and services on the market and evaluate their suitability for current needs; Step 630: Design an architecture mode of the adapter, such as adopting a middleware mode, a sidecar mode, or a gateway mode; Step 640: Develop an adapter component according to specific requirements to implement specific protocol conversion logic and data mapping rules; Step 650: Configure or program data field mapping in the adapter to ensure that the legacy system data can be correctly converted into the data model required by the microservice architecture; Step 660: Develop code to handle conversions between different communication protocols, such as converting XML messages to JSON format, or adapting to different API standards; Step 670: Integrate necessary security measures in the adapter, such as OAuth2 and JWT; Step 680: Perform comprehensive unit testing and integration testing to verify data conversion accuracy, protocol conversion functionality, and stability of inter-system communications.

8. A lightweight enterprise application interconnection interface system based on a digital basic platform according to claim 7, characterized in that: The method further includes step S700 of performing a comprehensive system test, including a unit test, an integration test, and a stress test; Adjust the configuration based on the test results to optimize performance.

9. A lightweight enterprise application interconnection interface system based on a digital basic platform according to claim 8, characterized in that: In step S700, the following contents are also included: Unit testing: writing test cases for code modules to verify the behavior of a single function or class to ensure that basic functions are correct; Integration testing: Testing the interaction between modules, checking whether the data flow and control flow meet expectations, and ensuring that services work together correctly; Stress testing: simulates high-concurrency scenarios, measures the system's performance under extreme conditions, and identifies performance bottlenecks and stability issues; Security testing: Conduct penetration testing and vulnerability scanning to verify the security of the system and ensure that data protection and access control mechanisms are effective; Performance benchmarking: Establish a performance baseline to quantify system response time, throughput and other indicators to provide a reference for subsequent optimization; Test result analysis: Summarize test reports, analyze failure causes, and identify performance shortcomings and potential stability risks; Configuration adjustment: Based on test feedback, adjust system configuration, such as resource allocation, cache strategy, thread pool size, etc., to optimize performance; Code optimization and refactoring: Optimize bottleneck codes and refactor codes when necessary to improve execution efficiency and maintainability; Regression testing: After adjustments and optimizations, re-execute the test suite to verify that the changes have not introduced new issues and ensure overall stability.

10. A storage medium, characterized in that: Non-temporary computer-readable instructions are stored for executing one or more modules in the aforementioned lightweight enterprise application interconnection interface system based on a digital basic platform.

Citation Information

Patent Citations

  • Multidisciplinary data model calculation integrated collaborative scientific research cloud service system

    CN115905723A

  • Unified identity authentication system based on containerized platform

    CN117056898A

  • Kubernetes-based service container scheduling method and system under cloud edge collaboration

    CN118337786A

  • Dynamic authorization and access management

    US20220224535A1

  • Multi-tenant identity and data security management cloud service

    WO2017196774A1