API Managing Component for Service Bus Visibility

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

As the development community expands to include diverse groups like IT, mobile, and third-party developers, managing and providing visibility into APIs becomes increasingly complex, especially in service bus environments, where APIs are used to connect various devices and platforms, necessitating improved API management and visibility.

Innovation Solution

A system and method for managing APIs exposed from proxy services in a service bus runtime, where each proxy service is exposed as an API entry in an API catalog, annotated with metadata, published to an API portal, and subscribed to by consumers, with a proxy interceptor delegating service invocations to an API managing component for usage metric collection.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Adaptability or versatility

If proxy services are exposed as API entries in an API catalog for diverse developer access, then API visibility and accessibility are improved, but API management complexity increases

Engineering Contradiction:

ImproveAPI visibility and accessibilityVSAvoidAPI management complexity

Core Design Contradiction:

Adaptability or versatilityVSDevice complexity

Solution Approach 1:

An API managing component is introduced as an intermediary between the service bus runtime and the API catalog. This component receives API key information from proxy interceptors and automatically collects usage metrics, eliminating the need for manual API management and reducing complexity while maintaining comprehensive visibility.

Inventive Principle:

Principle #24Intermediary (Mediator)

Solution Approach 2:

The system implements self-service automation where the API managing component automatically subscribes to API key information streams, collects usage metrics, and updates the API catalog without human intervention. This automated self-service approach handles the increasing API management complexity through systematic automation rather than manual processes.

Inventive Principle:

Principle #25Self-service

2Loss of information

If usage metrics are collected for all API subscriptions, then API usage visibility is improved, but system overhead increases

Engineering Contradiction:

ImproveAPI usage visibilityVSAvoidsystem overhead

Core Design Contradiction:

Loss of informationVSUse of energy by moving object

Solution Approach 1:

The API managing component subscribes to API key information streams and uses this feedback to automatically collect and analyze usage metrics. This feedback mechanism enables comprehensive visibility into API usage patterns while optimizing resource utilization by only processing relevant subscription data.

Inventive Principle:

Principle #23Feedback

Solution Approach 2:

Manual API usage tracking and metric collection processes are replaced with an automated subscription-based system. The API managing component automatically subscribes to relevant information streams and collects metrics programmatically, eliminating manual overhead while maintaining comprehensive usage visibility.

Inventive Principle:

Principle #28Mechanics substitution (Replace mechanical system)

Data Source

PatentUS10091086B2System and method for providing an application programming interface manager for use with a service bus runtime

Publication Date: 2018.10.02 ORACLE INT CORP

AI summary

In accordance with an embodiment, described herein is a system and method for managing APIs exposed from proxy services executing in a service bus runtime. Each proxy service can be exposed as an API entry in an API catalog, where the API entry can be annotated with metadata, and published to an API portal. The published API entries can be subscribed to by an API consumer for an application. The application can pass an API key when invoking a proxy service corresponding to a subscribed API entry. A proxy interceptor associated with the corresponding proxy service can intercept the service invocation, and delegate the service invocation to an API managing component. The proxy interceptor can provide the API key and a proxy service reference to the API managing component, which can use the API key to collect usage metrics of the API subscription for display at the API portal.