Browse Prior Art Database

A Method for Efficient and Integrated Web API management and Consumption

IP.com Disclosure Number: IPCOM000238484D
Publication Date: 2014-Aug-28
Document File: 2 page(s) / 63K

Publishing Venue

The IP.com Prior Art Database

Abstract

Disclosed is an efficient method to embed an Application Programming Interface (API) in an application. The method emulates the steps of directly programming to a local library embedded in the development tooling of the application write.

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

Page 01 of 2

A Method for Efficient and Integrated Web API management and Consumption

Application Programming Interface (API) methods expose business functionality for consumption through the Web by service providers. With these methods, application developers must perform the following:


1. Find the right Web API


2. Read and understand the API usage


3. Determine the API signature in the desired language and code the API


4. Code appropriate error handling


5. Find and provide any dependency libraries that are required by the API


6. Test the API

These steps are manual and often consume many hours to perform . This hinders overall productivity.

A more efficient method is needed for embedding the API in an application .

The solution proposed in this disclosure consists of two parts: a service provider side and a client tooling/development side. This method increases productivity by emulating the steps for directly programming to a local library embedded in the development tooling of the application writer.

On the service provider side, the provider exposes an EmbedAPI for each business API that it manages. When the EmbedAPI is invoked, it returns a snippet of source code in the language used by the client application (e.g., Java*). That snippet of code is then seamlessly in-lined in the client code.

On the client side, the approach adds a capability to the Integrated Development Tooling so that at development time , the application author can search the entire Web for the API . The author clicks the found API. Then, the client integrated tool...