Applies to ReadyAPI 2.5, last modified on October 5, 2018

The Generate Documentation feature allows you to create HTML documentation for your service interfaces and store it in a file.

To create a documentation file:

  1. Right-click the interface and select Generate Documentation.

    Generating the documentation

    Note: You can also select the interface, open the API menu and select Generate Documentation.

    Generate the documentation from the API menu
  2. The Create Documentation dialog appears.

    Click Browse to specify the folder to save the report to.

    The Create Documentation dialog

    Click the image to enlarge it.

  3. Click OK.

You can view the new report in the browser:

The HTML report

Click the image to enlarge it.

See Also

Updating, Refactoring and Exporting APIs

Highlight search results