Dismiss
InnovationQ will be updated on Sunday, Oct. 22, from 10am ET - noon. You may experience brief service interruptions during that time.
Browse Prior Art Database

Technique for automated API creation on API platform using OSLC APIs and RDF/XML Formats for defining APIs

IP.com Disclosure Number: IPCOM000235824D
Publication Date: 2014-Mar-26
Document File: 7 page(s) / 448K

Publishing Venue

The IP.com Prior Art Database

Abstract

APIs are programmable interfaces or hooks to an external application or service.Success stories of social APIs and their adoption are forcing large enterprises to look at leveraging APIs to further their business Evolution of APIs have shadowed the SOA story that was successfully spinning the enterprise application integration story for the past few years . To enable a easier transition to API adoption what is required is a seamless way to convert the SOAP Services to APIs , so that these WS services can participate easily in an enterprise API strategy using an API management platform. Most of the API management solutions available today do not allow for a automated way of creating APIs for SOAP services. There is little standarization in automated creation of APIs on API management platforms or in representing API and the attributes that define them . In this article we will look at one of the ways to achieve this, we will look at how API resources can be represented using RDF. To be specific in this article we will look at an approach for automated representation/discovery of SOAP services and definition of APIs as an RDF graph. The solution suggested through this proposal , provides a way to conceptualize APIs and SOAP services as artifacts, adopting standards like OSLC and RDF/XML gives a way to generalize the concept and make it extensible to any API management platform and any SOAP service runtime, as long as each of them can serve and invoke OSLC calls .

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

Page 01 of 7

Technique for automated API creation on API platform using OSLC APIs and RDF /XML Formats for defining APIs

Core concept : Use of OSLC APIs and RDF formats to achieve the easy definition of APIs from existing SOAP services

Advantages : Use of standards. Enables easier integration of API platform to tools or runtimes that host these SOAP services .

Pre-requisite


Understanding of OSLC and RDF concepts

Adopting and extending a standard like OSLC and RDF for automated API creation
Defining a resource model for API resource
Possibility of using the OSLC and RDF to define integration with a broader set of tools and runtimes that may in future look at automated creation of APIs or a capability of mapping their resources (like SOAP services) as a API
Help easy enablement of enterprises to expose their business critical SOAP services as APIs so as to have an edge in today's competitive market place.

OSLC Client can be an application on WebSphere Application Server that parses its deployed SOAP services WSDL and constructs the RDF/XML format for the API resource that needs to be created on the API management platform
OSLC client will get the creationURL from the Service Provider and initiate a HTTP POST to the creation URL , with the rdf resource defined (which is the api resource rdf/xml format) .

The OSLC Service Provider servicing the resource creation request will invoke the API management functionality to parse the RDF/XML to extract the data needed to create the API

Merits of the solution

By adopting standards like OSLC and RDF we are enabling the API platform to integrate and be operated by software that can interface with OSLC tools
With OSLC being adopted widely for tool integrations, it can be expected that most of the tools or runtimes would be built to work with OSLC interfaces
This gives a standard way of integration with API platform
Well defined resource representation for API resource
Concept can be extended to any API platform solution

1


Page 02 of 7

Solution

Define a RDF graph for an API resource

     What this would mean is to define API as a resource and its related properties as resources and properties .

API is already a HTTP resource, so defining it as a resource means no additional step, API has a unique URI representation (which is needed to represent API as a resource)

Arrive at a N-triples (or N-3) representation for an API (as defined on the API platform in this proposal discussion we will refer to IBM WebAPI management platform as API management platform)

     What this would mean is to use N-triples notation to define an API or an RDF/XML to define the API and its linked resources and its links.

The API platform is proposed to host a Service Provider [OSLC] that allows for creation of API resource using a creationURL and also allows for API querying using the queryBase URL of the ServiceProvider.

Any external tool or runtime that wishes to create an API on the WebAPI platform would do so through an OSLC client, by merely using...