REST Connector Series: An Introduction to the REST Connector
We’re lowering the barrier to connectivity with the release of a REST Web Services connector! The REST connector allows you to connect to any REST APIs defined by using an Open API Specification (formerly known as Swagger) – and it’s available now on the Marketplace!
We’re seeing adoption of the Open API Specification (OAS) from many SaaS apps and IT organizations to document their APIs, and leveraging Swagger technologies to generate client and server code. This allows users to rapidly implement the plumbing and focus on the implementation. The REST connector works in a similar pattern; provided a valid specification, TIBCO Cloud Integration will auto-generate a connection.
So, what is OAS anyway?
The Open API Specification (OAS) has emerged as the most common format for describing REST APIs. The specification documents various components that come together to fully describe an API and how to interact with it.
The Swagger UI visually represents the OAS, and lets you test API methods
Many APIs don’t have documentation to the degree we need as integration developers – such as ?WSDL in SOAP (example #1, example #2) or $metadata in OData (example). OAS is solving for the lack of standard or protocol on REST APIs with a human and machine-readable documentation framework.
There are many community and Swagger tools to work with OAS to help make understanding APIs intuitive that I’ll talk about later.
Swagger UI provides documentation, Authentication, and API Test Calls
How does it work in TIBCO Cloud Integration?
The OAS document is uploaded to a REST connection by URL or pasted into the connection definition. That JSON is translated to TIBCO Cloud Integration metadata (Operations, Endpoints, Relationships, and Fields). I’m going to go into detail on creating a REST Web Services connection later.
- This release date: April 2018
- Help Documentation: https://help.scribesoft.com/scribe/en/#sol/conn/rest.htm
- Getting to know Swagger and building/modifying a spec
- Connecting a Connection to the REST Connector
- Common integration patterns with REST
- Helper Tools
First Published May 08, 2018
About the Author
Nate Keefe is a Product Manager at TIBCO Software.