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

REST Services

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

...

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

Documentation

In the REST service editor, each operation has a field for documentation that will be used in the 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.

Function Flows

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

...

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

Documentation

In the Function tab of a Function Flow, you have the ability to specify documentation for the function in general and for each input and output parameter.

...