How to select OpenAPI/Swagger file using COZYROC OpenAPI Import Wizard

How to select OpenAPI/Swagger file using COZYROC OpenAPI Import Wizard

The OpenAPI import wizard (introduced in 2.0 release) enables quick, automated creation of resources, endpoints, parameters and fields from an OpenAPI specification (formerly Swagger specification). To learn more about OpenAPI see here.

By following the steps mention below, you will be able to import in your custom REST configuration all the endpoints you would like to use in your SSIS packages.

1- Open a New Connection and select the REST from the wizard mention in below screen shot 1.0     

Screen Shot 1.0
2- Select Custom from the Dropdown list as mention in below screen shot 1.1

Screen Shot 1.1
3- Click on the Wrench icon in the next wizard mention in the below screen shot 1.2

Screen Shot 1.2

4- Select the OpenAPI import from the dropdown list and click on Ok button

Screen Shot 1.3
5- Click on Browse in the next wizard and choose either a local YAML/JSON file or specify a URL for downloading it as mention below in the sreen shot 1.4

Screen Shot 1.4

  NOTE: The file needs to be a valid v2 or v3 specifications

6- Filter you endpoints and click on the Next button as mention in screen shot 1.5 and click on Next Button

Screen Shot 1.6
NOTE: Endpoints can accept and return data in different formats, you quickly narrow down the list of points by choosing only the content types, you are interested it.
For more information about OpenAPI content types please refer to https://swagger.io/docs/specification/media-types/

7- Select the endpoint you wish to import and click on the next button as mention in screen shot 1.6 and click on Next Button

Screen Shot 1.6
NOTE: In this step, you will select which endpoints to import in the REST Configuration. The left grid contains all endpoints from the OpeAPI spec file, which were not excluded by the filters in the previous step. You can double click on an endpoint or use the arrows to move them to the right grid which includes the selected endpoints. You can also change the operation type of POST/PUT/PATCH endpoints in the right grid.

8- Map OpenAPI data type and format to SSIS data type or a field template as mention in screen shot 1.7 and click on Next Button

Screen Shot 1.7
NOTE: In this step, you can tweak the mapping between each pair of OpenAPI data type and format to a corresponding SSIS data type or a template field. If you find out that you need introduce new template fields, you will need to do it manually in the REST Configuration Editor and then restart the wizard.

9- Organize your endpoints in resources as mention in screen shot 1.8 and click on Finish Button

Screen Shot 1.8
NOTE: The selected endpoints will be automatically grouped by resources by the wizard, but you can edit the resource names and thus change the suggested grouping. Generally, endpoints that model a single entity are recommended to be grouped in a single resource for easier management of their related fields.

10- Upon clicking "Finish", if there are existing resources with coinciding names, you will be asked whether to replace them or skip them as mention in screen shot 1.9

Screen Shot 1.9
After a summary of the operation, results gets displayed, you can inspect and if necessary further customize the newly created entities (resources, fields, endpoints, parameters) in the REST Configuration Editor.
NOTE: The OpenAPI import won't import any information about authentication logic, paging logic (for GET endpoints), and custom fields processing logic.

    Book a Presales Call

     

    Are you new to COZYROC and evaluating our solutions? 
    Book a Presales Call with us now.