REST Custom OpenAPI Import
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.
In 5 simple steps, you will be able to import in your custom REST configuration all the endpoints you would like to use in your SSIS packages.
Step 1 - Select an OpenAPI/Swagger file
You can choose either a local YAML/JSON file or specify a URL for downloading it.
NOTE: The file needs to be a valid OpenAPI v2 or v3 specification.
Step 2 - Initial endpoints filtering
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/
Step 3 - Select endpoints to import
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.
Step 4 - Map data types
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.
Step 5 - Organize endpoints in resources
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.
Upon clicking "Finish", if there are existing resources with coinciding names, you will be asked whether to replace them or skip them:
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.