Getting the best Oracle API information with Swagger and a pinch of NodeJS by Léon Smiers

September 26, 2017 Leave a comment

image

In a world full of API’s we need to have a way to understand the functionality and meaning of an API before we can start using it. In the Oracle Cloud world (SaaS, PaaS and IaaS) all (or at least most) API’s are defined as REST services, based upon a JSON structure.
Since there is no conformed standard between API delivering parties, different design frameworks are used, with OpenAPI Specification (Swagger), RAML and API Blueprint the most popular ones. Oracle is opting for the OpenAPI Specification, with the accompanying design tool Swagger, as the standard for their products.

Oracle combined all the tools and resources for Cloud and On-prem software in a developers website. On this website the API descriptions for all PaaS products can be found. Unfortunately the information provided in the API overviews are pretty minimal. The online Swagger editor is not helping either, with all sorts of warnings popping up. The Swagger locally used UI tool requires CORS enabled calls, so out-of-the-box is offering the support we need.

This blogpost is about adding the last step in order to get insight in the Oracle PaaS API definitions with the Swagger UI tool. With the help of NodeJS CORS is added to the PaaS API call, and delivers the insight we want!

OpenAPI specification and Swagger

The OpenAPI specification is described on the http://swagger.io/specification/ website and unfolds how both Design elements and Documentation are used to define an API. The entire structure of the API design is based upon JSON, though also YAML can be used as the underpinning language. Swagger supports this specification with a bunch of tools, that can be used both in-line and locally installed. Read the complete article here.

SOA & BPM Partner Community

For regular information on Oracle SOA Suite become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

Blog Twitter LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

Filed under Cloud, SOA Tagged with , , , ,

Unknown's avatarAbout Jürgen Kress
As a middleware expert Jürgen works at Oracle EMEA Alliances and Channels, responsible for Oracle’s EMEA Fusion Middleware partner business. He is the founder of the Oracle SOA & BPM and the WebLogic Partner Communities and the global Oracle Partner Advisory Councils. With more than 5000 members from all over the world the Middleware Partner Community is the most successful and active community at Oracle. Jürgen manages the community with monthly newsletters, webcasts and conferences. He hosts his annual Fusion Middleware Partner Community Forums and the Fusion Middleware Summer Camps, where more than 200 partners get product updates, roadmap insights and hands-on trainings. Supplemented by many web 2.0 tools like twitter, discussion forums, online communities, blogs and wikis. For the SOA & Cloud Symposium by Thomas Erl, Jürgen is a member of the steering board. He is also a frequent speaker at conferences like the SOA & BPM Integration Days, JAX, UKOUG, OUGN, or OOP.

Leave a comment