Exporting APIs

Applies to ReadyAPI 3.53, last modified on May 15, 2024

After you modify an API in ReadyAPI, you can export it to the server as a service definition. The way you export your API depends on the API type. Definitions of SOAP services can be exported in WSDL only. REST service definitions can be exported in OpenAPI, Swagger and WADL formats.

Export to WSDL

You can export a SOAP API definition to a WSDL file. Right-click the service definition in the Navigator panel and select Export Definition from the context menu. Then, select the folder you want to save the definition to:

Exporting the definition

Export in the OpenAPI or Swagger format

To export a REST API definition in the OpenAPI or Swagger format, right-click the APIs node in the Navigator panel and select Export Swagger/OpenAPI Definition from the context menu:

In the subsequent window, configure the export parameters:

Exporting the Swagger definition

Click the image to enlarge it.

Note: ReadyAPI displays the dialog only if your project contains REST APIs.

ReadyAPI exports the service definition to the api-docs file. The file extension depends on the selected format (.yaml, .json or .xml). You can specify the file format, the output folder and other options in the dialog:

Option Description
APIs The APIs you want to export to the definition file.
Version The version of the OpenAPI (or Swagger) specification.
Target File The output directory for the resulting api-docs file.
Format Specifies the output file format.
Possible values: json, yaml, xml.

Export to SwaggerHub

ReadyAPI supports SwaggerHub SaaS and SwaggerHub On‑Premise 1.23.0-46 or later.

To export a REST service definition in the Swagger 2.0 or OpenAPI 3.0 format:

  1. Right-click the service in the Navigator panel and select Publish to SwaggerHub.

  2. In the subsequent dialog, configure the export parameters:

    Publishing a definition to SwaggerHub

    Click the image to enlarge it.

    Parameter Description
    URL SwaggerHub cloud service users: https://api.swaggerhub.com (default value).
    SwaggerHub On-Premise users: Select the Use on-prem URL check box, then specify the URL of your SwaggerHub On-Premise instance.
    Login Your SwaggerHub user name.
    Password Your SwaggerHub password.
    Owner The name of the API owner (a user or an organization).
    Unique API name The name of the API. The name must be 3 to 60 characters long, must start and end with a letter or digit, and can have the A..Z a..z 0..9 - _ . characters.
    Version The API version. For example: 1.0, 1.0.0, 1.0b5, beta.
    OAS Version The format of the created API: Swagger 2.0 or OpenAPI 3.0.
    Remember credentials Select if you want to save the entered credentials for future exports.
    Private Select if you want to make the API private.
  3. Click OK.

Export in the WADL format

To export the definition of a REST service in the WADL format, right-click the service in the Navigator panel and select Export WADL from the context menu. Then, specify the file to save the definition to.

Exporting WADL
Note: If you created a service from an OpenAPI or Swagger definition or created it from scratch, you cannot export it in the WADL format.

See Also

Refactoring REST APIs
Refactoring SOAP APIs
Working With APIs

Highlight search results