Message:

API Inspector

Visualize your service methods and run test invocations

API Inspector is the main user interface element of Backendless API Engine. It is an interactive tool which can be used as micro service documentation, service invocation test drive and a diagnostics tool.

Browse all features or select one to view

Browse all features or select one to view

Instant Service Visualization

The moment when a service is deployed into Backendless API Engine, service’s API Inspector is available to see service operations, method argument and response type schemas. Using API Inspector service methods can be invoked right from the console to make sure they operate as expected.

Interactive Documentation

API Inspector has an important role to document the service and its capabilities. Backendless uses the Swagger format to define the service, which is an open and widely adopted standard for documenting REST APIs.

Service Test Drive

Backendless API Engine user interface includes a 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.

External Service Access

By default the API definition document generated by Backendless is only accessible through Backendless console. The document can also be exposed through a public URL, which can be accessed 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.

Swagger Compatible

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 describing an external service can also be imported into Backendless. In that case, Backendless API Engine injects itself as a service proxy in order to provide API Management, security and service analytics functions.