In this video, you will learn how to create an OpenAPI document (Swagger file) directly from SnapLogic.
May 2018 Release: Swagger Generation
Hi! In this video I will demonstrate the set of steps required to generate an OpenAPI specification file also known as Swagger for APIs created in SnapLogic.
One of the key benefits of the Swagger specification file generated by SnapLogic is that it can be used in any API Management platform that supports OpenAPI 2.0 specification.
To create a Swagger file, I will need to create a project in the SnapLogic Manager view. Once the project has been created, I will create a simple pipeline defining a few pipeline parameters.
Now, we will switch to the OpenAPI tab on the pipeline properties window. This is the tab where I will assign Swagger defined formats for each of the pipeline parameters.
And as you can see, SnapLogic supports all the formats that are supported by the Swagger 2.0 specification.
After you select the format type, the SnapLogic pipeline is ready to turn into an API by creating a Triggered Task.
Once the Triggered Task is created, I am ready to turn into an OpenAPI specification. I will hover over my Projects menu on the left and select the OpenAPI option.
This will trigger an action where a YAML based Swagger specification file is created and downloaded automatically.
We can check and see the YAML file and see that the YAML file conforms to the Swagger 2.0 specification and success! The Swagger file is ready for consumption by any of the API Management platforms that include support for the industry recognized Swagger 2.0 specification.
Using the SnapLogic platform in conjunction with an API Management platform, users can enjoy the full lifecycle API Management benefits including enhanced security options, traffic management, API monetization and more.
Thank you for watching this video. Please visit docs-snaplogic.atlassian.net to learn more.