Message:

Swagger Integration

Code in, swagger out. Swagger in, code out

Backendless relies on swagger to document the generated REST APIs. When code is deployed to Backendless API Engine, a swagger document is produced describing the APIs. The document can be used with any swagger-compatible tool. Similarly, a swagger document can be imported into Backendless for externally located services. In that case, Backendless API Engine injects itself as a service proxy in order to provide API Management, security and service analytics functions.

Browse all features or select one to view

Browse all features or select one to view

Swagger Document Generator

Backendless automatically generates a Swagger description for the deployed hosted services – the services which run on the Backendless Platform. Service introspection uses method names as well as the semantics of the declared method arguments and return types to create a REST declaration of the method which then is documented in the corresponding Swagger document. The Swagger descriptor is available at a unique URL identifying the service and can be used externally to document the service.

Import Swagger Services

Similarly to the hosted services, Backendless can also process imported ones – i.e. services running elsewhere and defined using Swagger. When a Swagger document is imported into Backendless API Engine, a service proxy is created representing the Backendless service endpoint. Based on the Swagger document, Backendless generates service SDKs for Android, iOS, .NET and JavaScript.

External Access Mode

Backendless maintains a Swagger document for both hosted and imported services running in API Engine. By default the document is accessible through Backendless console but it can also be available through a public URL which can be access without console’s developer authorization. This may be useful when a Backendless API Engine service descriptor must be accessed by external teams or 3rd party partners.

API Test Drive

Backendless API Engine leverages Swagger’s API test drive, which is a powerful tool enabling method inspection and invocation of the deployed services. The tool lets you see the endpoint URIs for each method, inspect request headers, invoke any method with user defined arguments and see the service response.