Browse Prior Art Database

Method and system for optimal self-adjusting API definitions

IP.com Disclosure Number: IPCOM000238004D
Publication Date: 2014-Jul-25
Document File: 3 page(s) / 59K

Publishing Venue

The IP.com Prior Art Database

Abstract

Disclosed are a method and system for automated and dynamic application programming interface (API) definition and adjustment based on the API consumption trends.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 52% of the total text.

Page 01 of 3

Method and system for optimal self-adjusting API definitions

Current trends in the information technology (IT) and software industry make all the functionality of software solutions available through application programming interfaces (APIs). This allows a dramatic increase of data consumption, enables the building of eco-systems around API usages, and essentially underpins most of the Software as a Service (SaaS) applications.

To achieve effective consumption of such APIs however, the actual structure of the APIs must be well defined and user friendly . The APIs should neither be too verbose, nor too concise; neither too granular, nor too generic. Formulating such an optimal solution is a challenge for both traditional APIs and Representational State Transfer (RESTful) resource definition.

One current solution is for engineers to constantly make small changes to the API in response to user requests , along with extensive documentation of existing APIs for ease of use simplification. This entails a high level of manual work and an inefficient trial-and-error approach to API definitions. In addition, making many small changes can result in a significant number of obsolete

APIs.

The new solution is a method and system for automated and dynamic API definition and adjustment based on the API consumption trends.

Figure: Automated and dynamic API definition and adjustment

1


Page 02 of 3

All the functional and business services that are available for the consumption by external users are front -gated by API Management Proxy component. This API Management Proxy is transparent to the end users, since those users just collaborate

with the system through API invocations and do not know whether the API has been constructed using API Management tools or is a native API of the business logic

When the solution is rolled out to take the live traffic , there is a one-to-one relationship between external APIs and Internal APIs (at that point, the API Management Proxy serves as a pass through layer).

...