Bis LL24 war die Dokumentation der REST-API des Report Servers nur im Handbuch verfügbar. Jetzt gibt es eine Dokumentation und Spezifikation im OpenAPI-Format und eine detaillierte, visuelle Darstellung der Spezifikation direkt im Webinterface.
Nach der Aktivierung der REST-API aktivieren Sie einfach die Generierung der Spezifikationsdateien:
Gehen Sie zunächst zu Verwaltung > Erweiterte Einstellungen und stellen Sie sicher, dass beide Checkboxen aktiviert sind:
Die Dokumentation ist dann über http://<ServerName>/rs24/doc/v1 (z.B. http://localhost/rs24/doc/v1) verfügbar. Alternativ können Sie auch einfach auf den Link klicken, der nach dem Klicken auf Speichern erscheint.
Sie können sogar Clients oder Testfälle in fast jeder beliebigen Programmiersprache aus OpenAPI-Spezifikationsdateien (ob in .json oder .yaml) generieren, indem Sie eines der unten verlinkten Tools verwenden. Darüber hinaus können Sie sofort sehen, was Sie benötigen, um eine Operation aufzurufen und was sie zurückgeben kann.
Der combit Report Server stellt zwei verschiedene Dateien zur Verfügung: Swagger 2.0 und die neueste Standard OpenAPI Spezifikation 3.0.
- http://<ServerName>/rs24/doc/v1/swagger2
- http://<ServerName>/rs24/doc/v1/openapi3
Hier ist eine nicht vollständige Liste von Tools, die OpenAPI unterstützen:
- PostMan – https://www.postman.com/
- Microsoft Flow – https://flow.microsoft.com/en-us/
- IFTTT – https://ifttt.com/explore
- Swagger Codegen – https://github.com/swagger-api/swagger-codegen
Dies ist eine tolle neue Möglichkeit, die Interoperabilität zwischen dem Report Server und Ihren eigenen Anwendungen zu verbessern und die Verwendung der REST-API viel reibungsloser und einfacher zu gestalten.
Jochen Bartlau leitet als Geschäftsführer die Softwareentwicklung bei combit. Microsoft .NET und Agiles Projektmanagement sind zwei seiner Steckenpferde. Der technikbegeisterte Physiker und Vanlife-Enthusiast verbringt seine Freizeit am liebsten beim Wandern.
