Internal Browser Discovery

Use the built-in browser to record requests to a website, filter the results, and generate an API definition. ReadyAPI calls this process Discovery.

1. Start Browser Discovery

  1. From the main menu, select File and then New Empty Project.

  2. In the Navigator, click next to the APIs node, and select Discover API.

  3. Select Use the built-in browser and click Add API.

    Discover API dialog with two options for recording HTTP/HTTPS traffic: "Use an external client application or a browser" and "Use the built-in browser," which is selected.
  4. In the Discover API dialog, enter the definition URL or file path. You can take one of the following actions:

    • To record requests against an API definition, click Add and Record.

    • To record without a definition, click Record Without Definition.

    ReadyAPI opens the Recording Overview window.

2. Record Requests

  • In the Recording Overview dialog, confirm that Internal browser (HTTP, HTTPS) is selected in the dropdown, then enter the target URL. Click Go.

    Tip

    If your service generates many API calls on load, click Pause before navigating to the target page. Click Record to resume when ready.

    Note

    Some websites make additional API calls after the page loads. ReadyAPI records these automatically.

    Recording Overview window showing the internal browser with https://petstore.swagger.io/ in the URL field and the Go button highlighted, before recording has started.

3. Generate Service Definitions

  1. In the Recording Overview dialog, click Transactions to view the recorded requests and responses.

    ReadyAPI displays the recorded requests and responses. Click any entry to view its details.

  2. Select the recorded requests you need and click Generate services.

    Tip

    If you recorded several requests, deselect any you do not need. Otherwise, ReadyAPI creates API definitions for all available requests.

    Recording Overview Transactions tab showing the POST /pet transaction selected, with a detail panel open displaying 11 request headers, and the Generate Services button highlighted at the bottom.
  3. In the Generate Services dialog, select Generate Test Case to create a functional test or Generate Load Test to create a performance test. Click OK.

    Generate Services dialog with the Generate Test Case checkbox checked and highlighted, Create Load Test unchecked, and the OK button highlighted.

    ReadyAPI generates service definitions.

  4. In the Create Test Suite dialog, enter a name and click OK.

  5. In the Create Test Case dialog, enter a name and click OK.

  6. Confirm Close REST Discovery is selected and click OK.

    Tip

    To generate additional API definitions from the recorded requests, deselect Close REST Discovery before clicking OK.

    Success dialog confirming that REST resources have been added to Project 3, with the Close REST Discovery checkbox checked and the OK button visible.

    ReadyAPI creates a test case with the recorded request.

    Test Case 1 editor showing one recorded REST test step: Pet - Request 1, with status showing Not executed.

HTTPS Service Specifics

When you discover an HTTPS service, the browser establishes a secure connection and verifies whether the server certificate is trusted. If it is not, the browser displays a warning and stops creating the connection.

Internal test services often use self-signed certificates that are not trusted by default. To work with them, enable the Self-signed certificate option in the Internal Browser properties.

The browser uses SNI to verify that the certificate hostname matches the server hostname. If they do not match, the connection is blocked. To disable verification, deselect the Hostname verification option in the Internal Browser properties.

Important

These options pose a security risk when working with untrusted websites.

See Also

Publication date: