ReadyAPI HTTP Monitor

Applies to ReadyAPI 3.9, last modified on July 30, 2021

ReadyAPI HTTP Monitor is a tool that helps you keep track of SOAP traffic between your client and a server. The monitor supports WS-Security and SSL decryption in case you need to work with encrypted messages. The HTTP Monitor can intercept REST messages, but it is not optimized to work with them.

We recommend using the Tabbed desktop mode to work with the HTTP Monitor.
ReadyAPI Monitoring: HTTP Monitor

Click the image to enlarge it.

The monitor displays the logged messages at the top of the table, and shows the details of the selected message in the Message Content panel at the bottom. This panel includes both top and bottom editors for the sent request and received response.

Acting as a Proxy

In proxy mode, the HTTP Monitor acts as a standard proxy that forwards messages received from the client to the specified host. The client must be configured to use ReadyAPI as its HTTP proxy. You do not need to change the endpoint the client uses to access the service, you need only to configure the proxy used.

If your client uses WS-Security to make your requests safer, you need to specify the WSS Profile you use.

To configure ReadyAPI HTTP Monitor as a proxy:

  • Open your ReadyAPI project. You do not need to have the request you send in the same project.

  • Right-click the project and select Launch HTTP Monitor.

  • Set the following options:

    • Select the HTTP Proxy option.

    • Enter the Port number you want to run the proxy on.

    • If your service uses WSS, specify Incoming Request WSS and Incoming Response WSS so that the HTTP monitor can access the content of your messages.

    • If you send requests from ReadyAPI, select Set as Proxy to automatically set the HTTP Monitor as a proxy in ReadyAPI.

    • Enter Content types to monitor as a comma-separated string. Messages with a different content type will be ignored.

  • Click OK. ReadyAPI will start the monitor.

To catch the requests, make sure your application uses the proxy on the port you specified.

HTTP Tunneling

In the HTTP Tunnel mode, ReadyAPI HTTP Monitor waits for a request to be sent to it and then resends it to the specified host. This approach uses the HTTP Tunneling mechanism and can work with HTTPS traffic. You need to change the endpoint of your request so that it is sent to the HTTP monitor. The request will be resent to the endpoint specified in the HTTP Tunnel.

To configure SSL encryption, you need to specify SSL Keystore, Truststore and client keystore path on the Security tab. When ReadyAPI receives an encrypted message, it will decrypt the message, analyze it and then re-encrypt and send it to the target endpoint.

To configure ReadyAPI HTTP Monitor as a tunnel:

  • Open your ReadyAPI project. You do not need to have the request you send in the same project.

  • Right-click the project and select Launch HTTP Monitor.

  • Set the following options:

    • Select the HTTP Tunnel option.

    • Enter a service endpoint in the Set endpoint for HTTP Tunnel text box. This must be the final endpoint ready for the requests you send.

    • Select Reuse request state to keep cookies and authorization between tunneled requests.

    • Enter Content types to monitor as a comma-separated string. Messages with a different content type will be ignored.

    • If you use HTTPS, switch to the Security tab and configure SSL settings.

  • Click OK. ReadyAPI will set up the tunnel and get ready to receive requests from your client.

  • Make sure your client sends requests to the HTTP Monitor, otherwise, it will be impossible to record the requests.

Working With Captured Requests

After you capture a request, you can work with it in multiple ways:

  • Specify what messages to display by using the Request Host, Target Host, Interface and Operation drop-down lists.

  • Look into the message by using the Message Content panel.

  • Click to create a SOAP request API definition. There must be a matching operation in your projects' API definition.

  • Click to add the request to the functional test. If there is no appropriate SOAP definition, the request will be added as an HTTP Request test step.

  • Click to add the request to a SOAP virtual service.

All of these options are available on the HTTP Monitor toolbar.

ReadyAPI Monitoring: HTTP Monitor Toolbar

Click the image to enlarge it.

Configuring Monitor Options

To change some settings of your monitor, stop it and click . Change the settings in the subsequent dialog:

  • Change the Port the monitor runs on.

  • Change the maximum number of recorded messages in the Max Log field.

  • Set Request and Response WSS settings. These settings have no effect if you run the monitor in tunneling mode.

  • Limit Content types to monitor. By default, the field shows all possible message content types in the */subtype format for demonstration purposes. Enter your values using the standard media type syntax, that is type/subtype. Messages with a different content type will be ignored. To monitor messages of all content types, leave the field empty.

ReadyAPI Monitoring: HTTP Monitor Settings

Click the image to enlarge it.

See Also

Property Expansion
Testing APIs

Highlight search results