Creating Project From SwaggerHub Definition

This topic describes how to create a REST project based on a definition stored in SwaggerHub.

1. Select File > New Project.

   

   – or –

   Use the New Test tile on the Dashboard.

2. In the Create Project dialog, switch to the SwaggerHub tab.

3. Select a definition or definitions that you want to import into your project.

   

   Click the image to enlarge it.

   • My API contains APIs created by or shared with the SwaggerHub account that you have added to ReadyAPI. If you haven't added an account, click Log In to SwaggerHub.

     Log in to SwaggerHub

     Log in to SwaggerHubLog in to SwaggerHub

     

     1. If you use SwaggerHub On-Premise, select Use on-prem URL and enter the URL of your SwaggerHub instance.

     2. In the Username field, enter your SwaggerHub username.

        Note:

        The SwaggerHub integration does not support logging in with a GitHub account.

     3. In the API Key field, enter your API key.

        Tip:	If you click Get API Key, you will be taken to the SwaggerHub API Keys page in your web browser. You can copy your API key from there.

   • Public API contains all the APIs in SwaggerHub that you have access to.

   Tip: Use search and filter functionality to find the APIs you need.

   Filter reference

   Filter referenceFilter reference

   Filter	Description
   Public	Shows APIs that are marked as Public in SwaggerHub.
   Private	Shows APIs that are marked as Private in SwaggerHub.
   OAS2	Shows OpenAPI Specification ver. 2 (Swagger 2.0) definitions.
   OAS3	Shows OpenAPI Specification ver. 3 definitions.

4. Select versions of definitions that will be imported. The default version (marked with ) of the definition is selected by default:

   

   Click the image to enlarge it.

5. Click Create project.

ReadyAPI will create the project based on the selected service definitions.

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

Next steps

See Also

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