API Validator Tool for REST Specification Compliance

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

Inexperienced teams creating RESTful APIs often implement problematic solutions due to the flexibility of REST architectural style, lacking guidance and resulting in inconsistencies and poor practices across APIs.

Innovation Solution

An API Validator Tool that receives API definitions and standards data, performs validation, and generates a compliance score, ensuring consistency and adherence to best practices by parsing API specifications and providing a user interface for validation results.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Adaptability or versatility

If flexibility is provided in REST architectural style, then adaptability and versatility are improved, but consistency and reliability deteriorate due to lack of guidance and varying implementation quality

Engineering Contradiction:

ImproveflexibilityVSAvoidconsistency

Core Design Contradiction:

Adaptability or versatilityVSReliability

Solution Approach 1:

The patent changes the parameter of API specification from completely open-flexible to constrained-by-standards. By introducing mandatory standards (versioning, authentication, error handling, etc.) that APIs must adhere to, the system maintains REST flexibility while ensuring consistent quality and reliability across all APIs in the registry.

Inventive Principle:

Principle #35Parameter changes

Solution Approach 2:

The validation tool provides feedback to developers about their API specifications, indicating whether they meet the required standards. This feedback mechanism allows developers to adjust their implementations to achieve both flexibility and consistency, resolving the contradiction by making the standards compliance visible and actionable.

Inventive Principle:

Principle #23Feedback

2Measurement precision

If manual validation of API specifications is performed, then measurement precision and quality control are improved, but productivity and time consumption deteriorate

Engineering Contradiction:

Improvevalidation accuracyVSAvoidAPI development speed

Core Design Contradiction:

Measurement precisionVSProductivity

Solution Approach 1:

The validation tool enables self-service automated validation of API specifications. Instead of requiring manual review by experts, the system automatically checks API definitions against established standards, providing precise validation at scale without sacrificing development productivity.

Inventive Principle:

Principle #25Self-service

Solution Approach 2:

The patent replaces the mechanical process of manual validation with an automated computational validation system. The tool programmatically analyzes API specifications against standards, substituting human manual review with automated checking that maintains precision while dramatically improving productivity.

Inventive Principle:

Principle #28Mechanics substitution (Replace mechanical system)

3Reliability

If comprehensive API standards and validation rules are implemented, then reliability and quality are improved, but device complexity and implementation difficulty increase

Engineering Contradiction:

ImproveAPI qualityVSAvoidvalidation system complexity

Core Design Contradiction:

ReliabilityVSDevice complexity

Solution Approach 1:

The validation system is segmented into distinct modular components, each responsible for validating specific aspects of API specifications (versioning, authentication, error handling, etc.). This segmentation makes the complex validation process manageable, maintainable, and easier to implement while ensuring comprehensive quality control.

Inventive Principle:

Principle #1Segmentation

Solution Approach 2:

The validation tool is designed as a universal system that can validate multiple types of APIs against multiple standards through a single platform. By creating a multi-functional validation engine that handles various API specifications and standards, the system reduces overall complexity compared to having separate validation tools for each standard.

Inventive Principle:

Principle #6Universality (Multi-functionality)

4Measurement precision

If API validation scoring and ranking are implemented, then measurement precision and quality assessment are improved, but loss of information and data processing requirements increase

Engineering Contradiction:

Improvequality assessment accuracyVSAvoiddata processing overhead

Core Design Contradiction:

Measurement precisionVSLoss of information

Solution Approach 1:

The validation system extracts only the essential quality metrics from comprehensive API specifications to create concise scoring summaries. By taking out and focusing on the most critical validation results (pass/fail status, compliance scores, key deficiencies), the system maintains precise quality assessment while minimizing data processing overhead and information loss.

Inventive Principle:

Principle #2Taking out (Extraction)

Data Source

PatentUS10740215B2System and method for implementing an API validator tool

Publication Date: 2020.08.11 JPMORGAN CHASE BANK NA

AI summary

The invention relates to an API Validator that allows developers to rate their Open API Specification (e.g., swagger files, API contracts) based on the standards for building APIs. The tool may parse the contract and look for compliance (or non-compliance) with the standards, using algorithms. A detailed report and overall score is presented to the developer once the contract has been checked. An embodiment of the present is directed to a plug-in that enables metrics generation as part of an automated build process. An embodiment of the present invention provides an integration process that enables a developer or other user to automatically resolve validation issues identified with APIs.