API Dependency Mapping for Journey Test Validation

Resolve Bottlenecks,
Find Innovative Solutions
Generate Solutions

Solution Overview

Problem

Existing API management systems are unable to effectively validate user journeys by mapping the availability of a sequence of APIs, leading to difficulties in identifying which user journeys are impacted by individual API unavailability or downstream API unavailability.

Innovation Solution

A computer-implemented method for analyzing user journeys through API dependency mapping, where a test script representing a user journey is received and an API dependency map is generated, illustrating the sequence of APIs and their dependencies, with status updates displayed to users, enabling identification of unavailable APIs and their impact on user journeys.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Measurement precision

If individual APIs are monitored for unavailability, then API availability can be tracked, but the impact on user journeys and downstream APIs cannot be identified

Engineering Contradiction:
ImproveAPI availability trackingVSAvoidUser journey impact information
Core Design Contradiction:
Measurement precisionVSLoss of information

Solution Approach 1:

The patent combines individual API monitoring with user journey tracking by creating a unified system that monitors APIs within the context of complete user journeys. The journey validation service correlates API availability data with journey definitions to determine overall journey status, merging previously separate monitoring functions into an integrated solution that provides both granular API tracking and holistic journey impact assessment.

Inventive Principle:
Principle #5Merging (Combining)

Solution Approach 2:

The journey validation service acts as an intermediary layer between individual API monitoring and user journey impact analysis. This intermediate service receives API availability data, correlates it with journey definitions, and produces journey-level validation results, enabling the system to bridge the gap between tracking individual APIs and understanding their collective impact on user experiences.

Inventive Principle:
Principle #24Intermediary (Mediator)

2Reliability

If multiple APIs are monitored in sequence, then comprehensive coverage is achieved, but the complexity of identifying impacted user journeys increases

Engineering Contradiction:
ImproveUser journey validationVSAvoidAPI dependency mapping
Core Design Contradiction:
ReliabilityVSDevice complexity

Solution Approach 1:

The patent segments the complex problem of user journey validation into distinct components: journey definition, API sequence identification, individual API monitoring, and journey-level correlation. By dividing the system into these manageable segments, each handling a specific aspect of the validation process, the overall complexity is reduced while maintaining comprehensive validation capability across multiple APIs in sequence.

Inventive Principle:
Principle #1Segmentation

3Device complexity

If existing API management systems monitor individual APIs, then system simplicity is maintained, but downstream API unavailability cannot be detected

Engineering Contradiction:
ImproveMonitoring system structureVSAvoidDownstream API detection
Core Design Contradiction:
Device complexityVSReliability

Solution Approach 1:

The system performs preliminary action by pre-defining user journeys and their associated API sequences before monitoring begins. By establishing the expected API call sequences and dependencies in advance, the system is prepared to detect downstream API unavailability when it occurs, enabling proactive identification of issues rather than reactive monitoring.

Inventive Principle:
Principle #10Preliminary action

Data Source

PatentUS20230214312A1Mapping API dependencies for a journey test
Publication Date: 2023.07.06 AMERICAN EXPRESS TRAVEL RELATED SERVICES CO INC
  • US20230214312A1 patent drawing
  • US20230214312A1 patent drawing
  • US20230214312A1 patent drawing

AI summary

Disclosed herein are system, method, and computer program product embodiments for mapping API dependencies for a journey test. An embodiment operates by receiving, at a graphical user interface (GUI), a test script representing the user journey within an application, wherein the test script specifies a sequence of application programming interfaces (APIs) that have been called as a user journeys through the application. The embodiment generates an API dependency map within the GUI comprising a sequential map of visual objects, illustrating (1) each of the APIs specified in the test script and (2) any dependent API called by each of the APIs. The embodiment executes the test script representing the user journey. The embodiment generates a status corresponding to each of the APIs called when executing the test script. The embodiment causes display of the generated status of an API or dependent API within the GUI selected by the user.