Automated API Adapter Source Code Generation

Resolve Bottlenecks,
Find Innovative Solutions
Generate Solutions

Solution Overview

Problem

Existing API adapter development for multi-service coordination execution apparatuses requires manual design and implementation of modules, making the process time-consuming and costly, especially when dealing with new wholesale services or changes in service specifications.

Innovation Solution

An API adapter creation apparatus and method that includes an API execution order setting unit, API request parameter acquisition source setting unit, API response parameter reflection destination setting unit, and a source code generation unit, which automates the generation of source code for the adapter API based on predefined settings, reducing the need for manual coding and focusing on logic development.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Ease of operation

If manual design and implementation of API adapter modules is performed, then flexibility and control over the adapter functionality are improved, but development time and cost increase

Engineering Contradiction:
Improvecontrol over adapter functionalityVSAvoiddevelopment time
Core Design Contradiction:
Ease of operationVSLoss of time

Solution Approach 1:

The patent applies preliminary action by pre-defining module templates with standard interfaces and behaviors before actual adapter development. These templates include common API adaptation patterns, error handling mechanisms, and integration logic that can be reused across multiple wholesale services, eliminating the need to manually design these foundational elements each time.

Inventive Principle:
Principle #10Preliminary action

Solution Approach 2:

The patent uses copying by creating reusable module templates that can be replicated and adapted for different wholesale services. Instead of manually designing unique adapters from scratch, developers can copy existing templates and modify them to fit specific service requirements, significantly reducing development time while maintaining functionality.

Inventive Principle:
Principle #26Copying

2Adaptability or versatility

If more modules are manually designed and implemented in the API adapter, then functionality and adaptability are improved, but development complexity and cost increase

Engineering Contradiction:
Improveadaptability to new servicesVSAvoiddevelopment complexity
Core Design Contradiction:
Adaptability or versatilityVSDevice complexity

Solution Approach 1:

The patent applies segmentation by dividing the API adapter into independent, modular components that can be separately designed, developed, and maintained. Each module handles a specific aspect of API adaptation (e.g., authentication, data transformation, error handling), allowing developers to work on individual modules without affecting the entire system, thus reducing overall complexity.

Inventive Principle:
Principle #1Segmentation

Solution Approach 2:

The patent implements universality by designing module templates with standardized interfaces and configurable parameters that can serve multiple wholesale services. A single module template can be adapted to work with different services by changing configuration settings rather than writing new code, enhancing adaptability while keeping development complexity low.

Inventive Principle:
Principle #6Universality (Multi-functionality)

3Productivity

If automated source code generation is implemented, then development speed is improved, but control over code quality and customization may be reduced

Engineering Contradiction:
Improvedevelopment speedVSAvoidcode quality control
Core Design Contradiction:
ProductivityVSManufacturing precision

Solution Approach 1:

The patent applies feedback by implementing validation mechanisms that automatically check generated source code against quality standards, API specifications, and business rules. The system provides feedback on potential issues in the generated code and allows developers to review and adjust parameters before final generation, ensuring code quality while maintaining high productivity.

Inventive Principle:
Principle #23Feedback

Solution Approach 2:

The patent implements dynamics by making the code generation process configurable and adaptable. Developers can dynamically adjust generation parameters, select specific templates, and customize the level of automation based on project requirements. This dynamic approach allows the system to balance automated speed with manual quality control as needed.

Inventive Principle:
Principle #15Dynamics

Data Source

PatentUS11487595B2API adapter creation device, API adapter creation method, and API adapter creation program
Publication Date: 2022.11.01 NIPPON TELEGRAPH & TELEPHONE CORP
  • US11487595B2 patent drawing
  • US11487595B2 patent drawing
  • US11487595B2 patent drawing

AI summary

An Application Program Interface (API) adapter creation apparatus is configured to accept, from a developing engineer, a setting of an execution order of a wholesale service API invoked by internal processing of an adapter API provided by an API adapter, a setting of a request parameter of the adapter API serving as an acquisition source of a request parameter of the wholesale service API, and a setting of a response parameter of the adapter API serving as a reflection destination of a response parameter of the wholesale service API. The API adapter creation apparatus generates a source code based on the accepted settings.