Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 21.1.2

...

You can manage the Bridge via a graphical user interface in your browser, but it also comes with a REST-based API. Many Bridge resources can be accessed via this API and you can view the API documentation online via the Bridge's user interface.

Figure: Accessing the Bridge API Documentation

The Bridge API Documentation provides an OpenAPI 2.0 Specification for documentation and testing purposes.Figure: The Bridge API Documentation

Info
iconfalse

If the UI of the Bridge API is empty, you may have ran into a compatibility issue with the xUML Runtime. In this case, restart your Bridge to solve the problem.

On this page, you can inspect the Bridge API interface and make HTTP calls to the resources.Figure: Bridge API - Ty It Out

The sandwich menu also provides a download option to download the YAML file of the Bridge API. Then, you can import the YAML file to your own client, e.g. if you want to access the Bridge via an xUML service.

...