Testing WSDLs (Try-it Tool)

The Try-it tool is provided by WSO2 as a quick and easy way to test your service's WSDL file or any publicly-available WSDL of the document/literal format. TryIt provides you with a mechanism to test your WSDL by creating endpoints on the fly. It helps to test a WSDL before actually coding it, without the need of a third-party WSDL validator tool. This functionality is provided by the following feature of the WSO2 feature repository:

Name: WSO2 Carbon - Tryit Feature
Identifier: org.wso2.carbon.tryit.feature.group

If the above feature is not included in your product by default, you can install it using the instructions given in section, Feature Management. 

Follow the instructions below to invoke the TryIt tool.

1. Log on to the product's management console and select Tools -> Try-It.

2. In the Enter URL field, type or paste the location of the WSDL and click Try It. It may be a local file system path or a web URL. For example,

3. There are two text areas on the Try-It tool for request and response. You can switch the layout y clicking either Horizontal or Vertical.  

Fill in the necessary parameters. If you need more typing space (for instance, the parameters take a blob of XML) you can expand the size of the input field by clicking on the small icon in the lower right corner of each field.

Invoke the operation by clicking Send. The return value immediately appears in the response text area.

Choosing Endpoints

You can change the endpoint for the service, if there are multiple endpoints. You can also specify a customized endpoint.

1. Click on the Using Enpoint - .... link. Select a new endpoint from the list and specify the address of the new endpoint.

Viewing the Service Information

1. To view the information about the service click on the Service Information link.

Prioritizing Operations

1. Use the small yellow icon with the plus (+) sign to prioritize operation.

2. The chosen operation is added to the Priority Operations section.

This will be useful when you have a lot of operations in the Try-It tool. Then you can add operations you want into this section and switch among them easily.

The Try-It tool is a full Ajax client and interacts with the service just as any other client would. Therefore, it is a good way to verify that a service not only works, but is reachable by its clients. Note however that the Try-It tool attempts to contact the web service at the endpoint url provided. If the domain or url scheme of the service is different from the endpoint, the browser may impose security restrictions. In this case, the Try-It tool falls back to using a script-injection protocol to tunnel the web service request. A wire trace of the communication with the browser will not show the actual web service messages used to communicate with the service.

Also, since the Try-It tool is fully asynchronous, it doesn't block while a web service is being invoked. You can invoke several operations before one of them completes (though it does not have a way to display the results of the same operation invoked multiple times.)

Invoking the Try-It tool through a Service's Dashboard

The TryIt tool can also invoked from the dashboard of a selected service. Service dashboard is part of the service management functionality provided by the following feature:

Name : WSO2 Carbon - Service Management Feature
Identifier : org.wso2.carbon.service.mgt.feature.group

The above feature is bundled by default in all service-hosting WSO2 middleware products. If the product you are using does not have this feature installed, you can do so by following the instructions given in section Feature Management. 

Follow the instructions below to try out the WSDL of a selected service.

1. Log on to the product's management console and click List under Services to open the Deployed Services page where all the currently active services are listed out.
   
   
2. Select a service and click on it to view its dashboard. You will see the Try This Service link n the Client Operations panel. 
   
   When you click the Try this service link, you will be directed to the page where the operations available for your service will be displayed. When you give the parameters for the operation, a button corresponding to your service appears. You can check whether your service provides the desired output by using this option. For more information, refer to the steps from Step3 above.
   
   The Try-It tool of a service can also be invoked by appending the service's endpoint reference with the ?tryit string. For example, http://<your-machine-ip>:<server port>/services/<service name>?tryit