Sunday, October 28, 2012

Extending WSO2 API Manager



WSO2 API Manager consists with two web applications as APIStore and APIPublisher. APIPublisher UI is important to create/publish APIs and APIStore UI is useful to create applications/subscribe to published APIs.

If we think about a use-case of  a company in which adopted the WSO2 APIManager solution; above Store/Publisher apps need to interact with third party users,not only with company internal employees.Such that in real business case,it's really important and useful if below two facts can be achieved through WSO2 API Manager apps.And ofcourse,it has proven that the below facts can be achieved from WSO2 API Manager.
  • Customizing both Store/Publisher apps
Customization is really needed,if the company want to host the two apps with using a customized theme and their logos.This can be easily done by the steps described in here.
  • Host Store/Publisher apps in a public domain own by the company
Host the apps in a public domain is a real world business requirement as above Store/Publisher apps need to interact with third party users.You can achieve this by following below steps.

NOTE: You have to try with API Manager pack from 1.1.0 on wards.Download the pack from here and extract it.


1) Open carbon.xml from the location {APIManager_Home}/repository/conf/ and uncomment below entries   
   , and add the related hostname value to them,

 To set the custom hostname as a part of the End Point References of deployed services in the server.
  <HostName>mydomain </HostName>
To use the custom hostname in Carbon management console
<MgtHostName>mydomain</MgtHostName>

2) Next,to change the displaying endpoints per a API from API-Store view, open api-manager.xml file from  
  /repository/conf/ and update the entry which can be found under configuration section as   
  below.

 <APIEndpointURL>http://mydomain>:${http.nio.port},https://mydomain:${https.nio.port}</ 
   APIEndpointURL>

3) Further if you want to change the apps context roots from default values as /store and /publisher to custom values.As an example,let's assume you want to change 'store' app context root from '/store' to '/apistore';
  • navigate to '{APIManager_Home}/repository/deployment/server/jaggeryapps/store/site/conf' and open the site.json file.Change its defined 'context' value as 'apistore' as follows.
  •          "context" : "/apistore"

  • Additionally change the directory name 'store' to 'apistore' from the location '{APIManager_Home}/repository/deployment/server/jaggeryapps'.That's it.Since jaggery apps hot deployment is enabled by default,try to access "http://yourDomain:port/apistore".



1 comment:

  1. Just in case no one has said it, this was helpful...

    I had figured it was easy enough, just didn't know how easy.

    Thanks!

    ReplyDelete