OpenAPI

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

OpenAPI and the model in Encore

Read more about how information from the model is mapped to the OpenAPI feed here. 

REST Services

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

1. 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 version parameters are required. The OpenAPI version is optional.

Examples:

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

2. Shortcut URL

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

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

The shortcut parameter is required.

Function Flows

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

{runtime-url}/server/api/v2/function/docs?project={project}&version={version}

Both project and version parameters are required. 

{runtime-url}/server/api/v2/function/docs?shortcut={shortcut}

The shortcut parameter is required.

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

Supported OpenAPI versions

Blueriq supports multiple versions of the OpenAPI specification. By default, version 3.1 of the specification is used, but the optional spec  query parameter can be used to request different versions: