Testing Demo Applications

There are 4 microservices deployed in the cluster by the setup.sh script. Three of them expose a few REST APIs and another one exposes SOAP APIs.

Those services that expose REST APIs come with Swagger UI to which you can use testing the APIs in each service. However, you can also use Postman to test both of REST APIs and SOAP APIs as well.

Table of Contents

• Requirements

• Postman Collection and Environment

• Testing REST APIs via Swagger UI

• Testing REST and SOAP APIs with Postman

  • Import Postman Collections and Environments

  • Testing API

  • Testing API Secured With OAuth

Requirements

• Postman

Postman Collection and Environment

There are 4 Postman collections you can use for API testing:

1. Demo Application Testing - Used for testing the APIs exposed by microservices through the OpenShift Route directly.
2. 3Scale API Testing (API Key Auth) - Used for testing the APIs exposed through API Gateway using API Key as a credential for authentication.
3. 3Scale API Testing (API Key Pair Auth) - Used for testing the APIs exposed through API Gateway using Application ID and Application Key pair as a credential for authentication.
4. 3Scale API Testing (OAuth) - Used for testing the APIs exposed through API Gateway with OpenID Connect OAuth 2.0 authentication.

There is also a Postman Environment file contains all environment vairables used by the collections. The enviroment variables are used to store values e.g. cluster domain, credentials etc.

Testing REST APIs via Swagger UI

1. Open a route for the service that you need to test.

   

   testing service
2. Append /swagger-ui at the end of URL then press Enter. You should be able to see Swagger UI page that shows all REST API endpoints exposed by the service.

   

   testing service
3. Click on the endpoint you need to test, the panel will expand. Then click on Try it out button.

   

   testing service
4. Enter paramenter(s) (if necessary), then click Execute button. The request URL and response will be shown up like a screenshot below.

   

   testing service

Testing REST and SOAP APIs with Postman

Import Postman Collections and Environments

1. Create a new workspace.

   

   import postman collection

   

   import postman collection
2. Import these Postman collections into the workspace.

   

   import postman collection

   

   import postman collection

   

   import postman collection

   

   import postman collection
3. Import this Postman Environments into the workspace.

   

   import postman environment

   

   import postman environment

   

   import postman environment
4. Edit Postman cluster-domain environment variable by replacing the OpenShift cluster domain you've provisioned in the CURRENT VALUE colume. Then click Save button.

   

   import postman environment

Testing API

1. Select Collections panel.

2. Open the request you need to test.

3. Make sure you've select the Default environment (should be done only once).

4. Click Send button to send request to server.

   

   import postman environment

Testing API Secured With OAuth

1. Select Collections panel then open the request you need to test. Go to Authorization tab, scroll to bottom then click Get New Access Token button.

   

   testing service
2. Postman will send request to Authentication Server (SSO, in this case) to get a token based on Client ID, Client Secret, and Realm configured in Postman Environments (variables). An access token should be returned from the server, then click Proceed button.

   

   testing service
3. The Manage Access Tokens dialog will pop up with access token details. Click on Use Token button Postman will populate necessary HTTP headers.

   

   testing service
4. Now you can submit a API request to server.

   

   testing service
5. You can reuse the access token with other API requests as well. In the Authorization tab for the request you need to reuse the token, just select the available token. And note that you can also manage existing tokens as well.

   

   testing service