News combit Dev Blog

Swagger and OpenAPI Support for Report Server REST API

Posted: Thursday, December 20, 2018 | 0 comment(s)
 
The OpenAPI Specification (OAS) defines a standard interface description for REST APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic.

Until LL24, the documentation of the Report Server's REST API was only available in the user manual. Now there is a documentation and specification in OpenAPI format and a detailed, visual representation of the specification directly in the web interface.

After enabling the REST API simply activate the generation of specification files:

First go to Management > Advanced Settings and ensure both checkboxes are checked:

rest-api-activate.png

The documentation is then available via http://<ServerName>/rs24/doc/v1 (e.g. http://localhost/rs24/doc/v1). Alternatively simply click the link which appears after clicking Save.

report-server-template-export.png


You can even generate clients or test cases in almost any programming language from OpenAPI specfication files (whether in .json or .yaml) by using one of the tools linked below. Furthermore you can instantly see what you need to call an operation and what it may return.

The combit Report Server provides two different files: Swagger 2.0 and the latest standard OpenAPI Specification 3.0.

  • http://<ServerName>/rs24/doc/v1/swagger2
  • http://<ServerName>/rs24/doc/v1/openapi3

Here's a non-exhaustive list of tools that support OpenAPI:

This is a great new way to enhance interoperability between the Report Server and whatever you're building and makes using the REST API a lot smoother and easier.




Author: Jochen Bartlau
Head of Development List & Label

Jochen Bartlau leads the development at combit as Managing Director. He's a Microsoft .NET enthusiast driving innovation & agile project management. The mobile devices geek who used to be a physicist in his first life loves to spend his spare time with his family.


  

+1 800 256 3608 (toll-free North America only)