Blueriq makes it possible to generate an OpenApi feed based on your Blueriq REST Services and Exposed Function Flows. OpenApi OpenAPI (previously know known as Swagger) comes with multiple specifications for defining RESTful interfaces. Blueriq chooses to generate generates a feed for OAS 3.0.

REST Services

The interfaces for REST services can be found at the following locations:

Project URL

This feed contains information of all operations as defined in REST services that are exposed as webservice by the requested project.

{runtime-url}/server/rest/docs?project={project}&version={version}

Both project and  and version parameters  parameters are required.{runtime-url}

Examples:

• http://localhost:160/runtime/server/rest/docs?

...

The shortcut parameter is required.

Example:
Image Removed

...

• project=studio-BaarsErrorHandling-BAARS&version=0.0-Trunk
• http://localhost:160/runtime/server/rest/docs?project=export-BAARS&version=0.0-Trunk

Shortcut URL

This feed contains information of all operations as defined in REST services that are exposed as webservice by the requested project or shortcut.shortcut.

{runtime-url}/server/rest/docs?shortcut={shorcut}

The shortcut parameter is required.

Using the development dashboard to copy the URL

You may also use the development dashboard to copy the OpenAPI spec URL in the widget named "Exposed Blueriq webservices":

Image Added

Documentation

In the REST service editor, each operation has a field for documentation that will be used in the OpenApi OpenAPI feed as the description of the corresponding Operation. The properties of the request/response body schema may be documented in the corresponding Domain Schema per attribute and relation.

Image Removed

Function Flows

The OpenApi feeds for Function Flows that are exposed as webservice are located at:

...

Each Function Flow that is exposed as webservice by the requested project is considered as Operation in the OpenApi OpenAPI interface.

If the property `blueriq.production.shortcutsOnly` is set and the Runtime is running in production mode, the project feed will throw a forbidden exception.

...

The general function documentation is available in the OpenApi the OpenAPI feed as the description of the operation. The parameter's documentation is specified in the OpenApi OpenAPI feed in the body schema definition.

Image RemovedImage Added