Automated REST API Validation via Dependency Parsing

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

Testing REST APIs is challenging due to their density, requiring manual and repetitive validation of numerous attributes and endpoints, with existing methods being time-consuming and lacking efficient tools for exhaustive testing with predictive validations and workflows.

Innovation Solution

An automated system parses API definitions to generate executable scripts that cover permutations and combinations of attributes, managing intra- and inter-dependencies in a machine-readable format, using JSON and YAML files to derive test cases for end-to-end verification without external logic, and continuously improving test coverage through learning techniques.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Loss of time

If manual validation methods are used for REST APIs, then flexibility and adaptability are maintained, but time consumption and labor effort increase significantly

Engineering Contradiction:

Improvetest development cycle timeVSAvoidautomation level

Core Design Contradiction:

Loss of timeVSExtent of automation

Solution Approach 1:

The system enables self-service automation by automatically generating test cases from API specifications without requiring manual test script creation. The automated validation system parses API definitions, identifies test scenarios, and executes validations autonomously, eliminating the need for manual test development while maintaining comprehensive coverage.

Inventive Principle:

Principle #25Self-service

Solution Approach 2:

The system performs preliminary action by pre-generating test cases from API specifications before actual API implementation or deployment. This advance preparation includes identifying all possible test scenarios, dependencies, and validation rules, which then can be executed automatically without manual intervention during the testing phase.

Inventive Principle:

Principle #10Preliminary action

2Reliability

If comprehensive test coverage is achieved through manual testing, then validation thoroughness improves, but resource requirements and complexity increase

Engineering Contradiction:

ImproveAPI validation thoroughnessVSAvoidtesting system complexity

Core Design Contradiction:

ReliabilityVSDevice complexity

Solution Approach 1:

The system replaces the mechanical manual testing process with an automated computational system. Instead of manual test script creation and execution, the system uses automated parsing of API specifications, algorithmic generation of test cases, and automated execution with result analysis, thereby reducing human effort while maintaining or improving validation thoroughness.

Inventive Principle:

Principle #28Mechanics substitution (Replace mechanical system)

Solution Approach 2:

The system creates copies of API specifications in machine-readable formats (such as OpenAPI/Swagger specifications) that can be automatically processed. These structured representations capture all API endpoints, parameters, responses, and dependencies, enabling automated test case generation without manually recreating test scenarios.

Inventive Principle:

Principle #26Copying

3Productivity

If automated test generation is implemented, then testing efficiency improves, but initial setup complexity and learning curve increase

Engineering Contradiction:

Improvetesting efficiencyVSAvoidsystem setup ease

Core Design Contradiction:

ProductivityVSEase of manufacture

Solution Approach 1:

The system achieves universality by designing a generic automated validation framework that can work with multiple API specifications and programming languages through standardized interfaces. The system parses common API specification formats (OpenAPI, Swagger) and generates test cases in various programming languages, making it broadly applicable without requiring language-specific setup for each project.

Inventive Principle:

Principle #6Universality (Multi-functionality)

4Measurement precision

If frequent validations are performed to improve API quality, then detection capability improves, but time and resource consumption increase

Engineering Contradiction:

Improvevalidation detection capabilityVSAvoidvalidation time consumption

Core Design Contradiction:

Measurement precisionVSLoss of time

Solution Approach 1:

The system implements periodic action by enabling scheduled or triggered execution of automated test suites. Validations can be performed at regular intervals, upon code commits, or when API specifications change, providing continuous quality assurance without requiring constant manual testing. The automated nature allows frequent executions with minimal additional time investment.

Inventive Principle:

Principle #19Periodic action

Data Source

PatentUS11599456B2Automated validation of a rest application programming interface

Publication Date: 2023.03.07 EMC IP HLDG CO LLC

AI summary

A system can system can parse a first group of dependencies within a first API, and second group of dependencies between the first API and a second API. The system can identify a group of assertions for the first API. The system can identify a group of validations for the first API. The system can identify a format for calls to the first API according to a first programming language based on a template for the first programming language. The system can generate a number of test cases that invoke the first API according to the first programming language based on the first group of dependencies, the second group of dependencies, and the format for calls to the first API. The system can invoke the first API with the test cases to validate functionality of the first API based on the group of assertions and the group of validations.