Expose SOAP API Through API Gateway

Steps

• 1. Create Backend API

• 2. Add Backend to Product

• 3. Configure Mapping Rules

• 4. Promote Changes to APIcasts (API Gateways)

• 5. Testing

1. Create Backend API

1. Go to OpenShift web console, make sure you're in Administrator perspective, change Project to demo, then go to Networking -> Services menu, and then click on the service you need to expose it's API(s) through API gateway.

   

   expose soap api
2. Copy the Hostname of the service and note the port number as well. Note that we use the Service object hostname instead of the Route's URL because:

   • the API gateway (APIcast) is deployed on the same cluster so it can internally access the Service in different projects/namespaces.

   • We need API consumers to access the API via API gateway only so the (public) Route's URL shouldn't be used and should be deleted later.

   

   expose soap api
3. Open 3scale API Management admin web console using the URL and credential provided at the end of the installation process. Then from the main dashboard, click on Create Backend button.

   

   expose soap api
4. Enter following details then click Create Backend button.

   • Name: Employee SOAP Service Backend

   • Private Base URL: http://employee-soap.demo.svc.cluster.local:8080/soap/service/employee

   Note. System name and Description are optional fields.

   

   expose soap api
5. A new backend should be created.

   

   expose soap api

2. Add Backend to Product

1. Click on dropdown list menu then select Product.

   

   expose soap api
2. Click Human Resource Services link.

   

   expose soap api
3. Select Integration -> Backends menu from left panel.

   

   expose soap api
4. Click Add Backend button.

   

   expose soap api
5. Enter following details then click Add to Product button.

   • Backend: Employee SOAP Service Backend

   • Path: /soap/employee

   

   expose soap api
6. A new backend should be added.

   

   expose soap api

3. Configure Mapping Rules

1. Select Integration -> Mapping Rules menu from left panel, then click Create Mapping Rule button.

   

   expose soap api
2. Enter following details then click Create Mapping Rule button.

   • Verb: POST (HTTP method for a particular API)

   • Pattern: /soap/employee (A particular REST API endpoint exposed via API gateway)

   • method or Metric to increment: Select Metric option and Hits from dropdown list menu.

   

   expose soap api
3. A new Mapping Rule should be created.

   

   expose soap api

4. Promote Changes to APIcasts (API Gateways)

Once we've configured everything in place in API Manager, we have to promote all changes to API Gateway (APIcast) to apply those changes.

Click on Integration -> Configuration menu from left panel. Then click Promote v.N to Staging APIcast button to promote changes to staging API gateway and click Promote v.N to Production APIcast button to promote changes to production API gateway.

expose soap api

5. Testing

1. Click on Applications -> Listing menu from left panel. Then click Test Corp HR Mobile link to open Application dashboard.

   

   expose rest api
2. Copy User Key.

   

   expose rest api
3. Open Postman then update user-key variable and click Save button.

   

   expose rest api
4. Test the APIs using 3Scale API Testing (API Key Auth) collection.