API Test Scenario Generation from Specification Files

Resolve Bottlenecks,
Find Innovative Solutions
Generate Solutions

Solution Overview

Problem

Traditional deployment processes for application programming interfaces (APIs) face issues such as code errors being detected too late, false negatives from erroneous inferences, and increased complexity due to manual testing across various hardware configurations, leading to inefficiencies in continuous integration and deployment.

Innovation Solution

Automatic generation of test scenarios from a specification file using environment-specific templates, which generate parameterized source code and corresponding tests, enabling validation and deployment across different environments, with security features to ensure authorized access.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Reliability

If tests are generated from pre-written code, then automated testing can be performed, but code errors are detected too late and false negatives occur from erroneous inferences

Engineering Contradiction:
Improvetest accuracyVSAvoiderror detection timing
Core Design Contradiction:
ReliabilityVSLoss of time

Solution Approach 1:

The patent applies preliminary action by generating test scenarios from API specification files (OpenAPI/Swagger) before the actual API code is written. The test generation occurs during the design phase using the specification as input, allowing tests to be created in advance of implementation. This enables early validation of API logic and detects errors before coding begins, rather than generating tests from completed code where errors are already embedded.

Inventive Principle:
Principle #10Preliminary action

2Reliability

If manual testing is performed across various hardware configurations, then comprehensive coverage is achieved, but testing complexity increases

Engineering Contradiction:
Improvetesting coverageVSAvoidtesting process complexity
Core Design Contradiction:
ReliabilityVSDevice complexity

Solution Approach 1:

The patent applies copying by creating virtual representations of different hardware environments through Docker container definitions stored in the database. Instead of physically deploying and manually testing on multiple hardware configurations, the system generates test scenarios that copy and simulate various environment characteristics. The test execution engine runs these scenarios in isolated containerized environments, achieving comprehensive coverage without the complexity of manual multi-platform testing.

Inventive Principle:
Principle #26Copying

3Stability of the object's composition

If parameterized code generation is used, then deployment consistency is improved, but initial setup complexity increases

Engineering Contradiction:
Improvedeployment consistencyVSAvoidsystem setup complexity
Core Design Contradiction:
Stability of the object's compositionVSDevice complexity

Solution Approach 1:

The patent applies parameter changes by using template files with placeholder parameters that are dynamically replaced during test scenario generation. The system stores environment-specific parameters (hardware configurations, software versions, network settings) in a database, and the test generation process substitutes these parameters into template patterns. This creates parameterized test scenarios that automatically adapt to different environments while maintaining a standardized generation process, reducing deployment inconsistency without requiring complex manual configuration for each environment.

Inventive Principle:
Principle #35Parameter changes

Data Source

PatentUS12505028B2Automatic generation of test scenarios from specification files
Publication Date: 2025.12.23 LPL FINANCIAL LLC
  • US12505028B2 patent drawing
  • US12505028B2 patent drawing
  • US12505028B2 patent drawing

AI summary

A method, a system, and computer program product for managing an application programming interface (API). A specification file including values describing an API is received. A template of the API is retrieved based on at least one of the values. A source code of the API and a test corresponding to the source code are generated using a parameterized predefined code from the template that is modified to replace parameters based on the values of the specification file. The source code of the API is validated using the test.