Overview
Swagger is the world’s most popular and largest framework of API’s developer tools for the open API specification. It enables development across the entire API lifecycle, from design and documentation to test and deployment.
At DBSync, we have created a solution that leverages Swagger API documentation specifications. Using this solution you can connect to any application that already has Swagger enabled APIs, or document APIs by following Swagger API documentation specifications in JSON format.
The biggest advantage you get when developing on our Swagger API solution is a hugely reduced connector development cycle. It goes down from weeks to only a few days. With APIs in Swagger JSON format you can expose your application as a connector on DBSync’s iPaaS tool Cloud Workflow, and integrate it with other supported applications.
Currently this is a beta version of Swagger API. New features continue to be rolled out every second week.
Use case
DBSync uses Swagger specification through its Swagger API connector, to build JIRA Core and JIRA Service Desk connectors. This considerably reduces the whole build cycle, allowing us to release new connectors faster. Now, our customers are able to integrate their JIRA cases/tasks with Salesforce or other CRMs.
How to use Swagger API
Connecting to Swagger enabled APIs
There are two ways to connect your Swagger Enabled APIs to DBSync’s Cloud Workflow. In both, you need to create a new connector from the Connectors section inside your project, and chose Swagger API Connector as Connector Type. Then, follow one of the following steps.
- Provide the Swagger URL where your API’s JSON is hosted in the corresponding section, together with credentials and authentication type.
- • Copy-Paste the entire JSON in the Swagger JSON section, together with credentials and authentication type.
Once you have successfully created the connector, you will proceed to create a process and its subsequent workflows. All the GET methods can be accessed from the Trigger section, and POST/PUT methods can be called from rules section within the workflows.
Developing new connectors using Swagger specifications
DBSync uses Swagger API Documentation Specifications as it is. You only need to write your JSON using the same. Specifications can be found here and a JSON example here.
Features
Open API Specification
The Open API specification (formerly known as Swagger Specification) creates a RESTful interface for easy development and consumption of an API, by effectively mapping all the resources and operations associated with it.
Turnaround Time
Developing on Swagger API minimizes the whole development cycle, from weeks to only a few days.
Develop without Code
No coding is required to develop new connectors. You just need to document your APIs in Swagger standard JSON format.
No Builds or Deployments
Any new connector developed is ready to be use on DBSync’s iPaaS Cloud Workflow platform. No additional builds or deployments required.
Get started
As a leading provider of iPaaS solution, DBSync is committed to superior performance.