API Mapper Code Generation for Breaking Version Changes

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

Managing breaking changes in application programming interfaces (APIs) is inefficient and resource-intensive, often requiring manual intervention and leading to integration failures due to the complexity of identifying and reconciling structural and semantic differences between API versions, especially in fast-paced software development environments.

Innovation Solution

A programming framework that uses API specifications to automatically generate mapper functions to bridge compatibility gaps between different API versions, reducing manual effort and ensuring seamless integration and backwards compatibility through annotation-based solutions.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Measurement precision

If manual inspection is used to identify breaking changes, then detection precision can be maintained, but time consumption and labor requirements increase significantly

Engineering Contradiction:

Improvebreaking change detection precisionVSAvoidtime for manual inspection

Core Design Contradiction:

Measurement precisionVSLoss of time

Solution Approach 1:

The patent replaces manual mechanical inspection with automated computer-based detection systems. The system automatically compares API schema definitions, detects breaking changes through structured algorithms, and generates migration code without human intervention, thereby maintaining detection precision while eliminating time-consuming manual processes

Inventive Principle:

Principle #28Mechanics substitution (Replace mechanical system)

Solution Approach 2:

The system performs self-service by automatically detecting breaking changes and generating migration code without requiring manual intervention. The automated detection mechanism inspects schema differences, identifies breaking changes, and produces bridging code autonomously, reducing both time consumption and labor requirements

Inventive Principle:

Principle #25Self-service

2Adaptability or versatility

If manual crafting of bridging code is performed, then adaptability to complex schema changes is maintained, but development time and complexity increase

Engineering Contradiction:

Improveadaptability to schema changesVSAvoidtime for developing bridging code

Core Design Contradiction:

Adaptability or versatilityVSLoss of time

Solution Approach 1:

The patent replaces manual code crafting with automated code generation systems. The system analyzes schema differences, determines appropriate bridging logic, and generates implementation code automatically, maintaining adaptability to complex changes while eliminating the time-consuming manual development process

Inventive Principle:

Principle #28Mechanics substitution (Replace mechanical system)

Solution Approach 2:

The system performs preliminary analysis of schema changes and automatically generates prepared bridging code before the actual migration is needed. This preliminary action includes detecting breaking changes, planning migration strategies, and generating code templates that can be directly applied, reducing overall development time

Inventive Principle:

Principle #10Preliminary action

3Stability of the object's composition

If multiple API versions are maintained simultaneously, then backwards compatibility is preserved, but system complexity and resource consumption increase

Engineering Contradiction:

Improvebackwards compatibilityVSAvoidcomplexity of maintaining multiple versions

Core Design Contradiction:

Stability of the object's compositionVSDevice complexity

Solution Approach 1:

The patent introduces automated intermediary systems that manage the complexity of maintaining multiple API versions. The system automatically generates version-specific schema definitions, detects breaking changes between versions, and creates bridging code that enables seamless transitions, thereby preserving backwards compatibility while reducing manual management complexity

Inventive Principle:

Principle #24Intermediary (Mediator)

Solution Approach 2:

The system performs self-service by automatically managing API version compatibility through automated schema comparison and code generation. The system monitors changes, detects breaking changes, and generates appropriate bridging code autonomously, maintaining multiple versions without requiring manual intervention and reducing overall system complexity

Inventive Principle:

Principle #25Self-service

Data Source

PatentUS20250272164A1Code generation to manage evolution of application programming interface

Publication Date: 2025.08.28 ORACLE INT CORP

AI summary

Disclosed herein is a programming framework that addresses the challenges of managing breaking changes in API versioning. A breaking change between a first version of an application programming interface (API) and a second version of the API may be detected. One or more mapper functions associated with the first version of the API and the second version of the API may be generated. A first version request may be received from a client computing device, wherein the first version request is compatible with the first version of the API. The first version request may be converted, via the one or more mapper functions, to a second version request, wherein the second version request is compatible with the second version of the API. The second version request may be provided to an endpoint of the API, and a second version response may be received from the endpoint of the API. The second version response may be compatible with the second version of the API. The second version response may be converted, via the one or more mapper functions, to a first version response, wherein the first version response is compatible with the first version of the API. The first version response may be provided to the client computing device,