Posts Tagged ‘Oracle API Catalog’

Quick & Dirty Overview of Oracle API Catalog

Posted: December 10, 2014 in 12c, SOA12c
Tags: , , , ,
0

High level overview of Oracle API Catalog

Oracle API Catalog (OAC) allows organizations to easily build catalog of their services offered (Web Service & REST/JSON Services) to provide better visibility for those who are intended to use/reuse the services.

OAC is an easy-to-use governance tool for capturing what services exist, what these services do, and how they can be consumed. OAC includes a simple meta-data model for an API asset, automation to populate OAC, and the ability for users to search OAC for APIs and understand the details of the APIs to assess their fit in the user’s application.

Strategy

Collect Service (harvesting)àAdd/Edit metadata to the service APIà Publish to API Catalogue à Discovered


Different Persona involved in API Catalog

Service Developer: One who develops the reusable services.

Curator: One who edits the meta-data and publishes the API for other developers to view /rate/use the publish APIs.

Developers: One who is going to use the services/APIs and rate them.

Administrator: Admin role user can perform both of the above mention roles.

High Level Installation Steps:

1. Install oer_generic.jar

2. Install patch # 18791727, this patch will extend the RCU with the required db object for OAC component.

3. Install patch # 18718889, this weblogic patch is required for weblogic server to address bug related to the failure of the web service session management.

4. Install patch # 19721053, this patch is need for installing jdeveloper 12c plug-in to connect to OER and OAC repository.

5. Run RCU to create OER and OAC db schema.

6. Extend current domain with OAC manage server to host OAC application.

High Level to register a Service

Once API Catalogue is installed successfully there are two ways to harvest (register) APIs into OAC.

  • Using Out-Of-The-Box API harvester tool-sets. This approach is prescribed when services are hosted in Oracle SOA Suite or Oracle Service Bus.
  • Using command line harvesting utility This approach is best prescribed when harvesting service base not form Oracle SOA Suite or Oracle Service Bus. Any services defined by a WSDL or WADL can be harvested using this approach.

Detailed Installation Step:

Install oer_generic.jar









Run RCU to create OER and OAC schema objects





Extend existing domain with OAC Manage Server


Select API Catalogue template (Note : don’t select Oracle API Catalogue and Oracle Enterprise Repository template together)




Create oac_server1







Logging to http://<your host>:<oac port>/oac for OAC Dashboard


For installing OAC plug-in in jdeveloper 12c , install patch # 19721053 using opatch utility.

Harvesting Step:

Using command line utility to harvest WSDL base Oracle Service Bus Proxy Service.

High level steps

  1. Edit HarvesterSetting.xml file.
  2. After providing default password.
  3. Encrypt the HarvesterSetting.xml.
  4. Run osb–harvest.sh script.

Detailed Steps

Edit HarvesterSettings.xml , change the default password value.

After changing the default password in the HarvesterSetting.xml, encrypt the password using the following command

The following code snippet shows how to harvest a simple WSDL using harvest.sh script.

 OAC dashboard after harvesting


After adding API meta-data for the harvest service