Creating Project From OpenAPI/Swagger Definition

Applies to ReadyAPI 3.4, last modified on October 14, 2020
Note: This topic describes how to create a REST project based on an OpenAPI or Swagger definition stored outside of SwaggerHub. If your definition is stored in SwaggerHub, you can import the definition right from SwaggerHub.

To create projects by using an OpenAPI or Swagger definition, follow these steps:

  1. Select File > New Project.

    New Project Button

    – or –

    Use the New Test tile on the Dashboard.

  1. In the Create Project dialog, switch to the Definition tab.

  2. Select Swagger/OpenAPI Definition (REST), specify the project name, the full path to the .yaml or .json specification file and the Default Media Type. You can specify the URL address of the specification or click Browse and select a local definition file.

    Create OpenAPI/Swagger Project

    Click the image to enlarge it.

  3. Click OK.

ReadyAPI will create the project based on your service description.

To learn how to create functional tests from the project, see Creating Functional Tests.

Possible Issues

ReadyAPI cannot import OpenAPI 3.0 specifications through HTTPS if the server where your spec resides has an invalid or expired security certificate. To work around this issue:

  1. Add the following option to the vmoptions file:

    -Dio.swagger.parser.v3.util.RemoteUrl.trustAll=true

  2. Restart ReadyAPI to apply the change.

Now you can import your OpenAPI specification.

Next steps

See Also

Creating Projects
Creating Project From REST URL
Creating Project From WADL Definition

Highlight search results