Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The OpenAPI feed is exposed by the runtime in JSON format. Read more about supported versions and how to get the URL and the supported versions here.

For a human readable version during development, you could paste the JSON into tools such as https://editor-next.swagger.io/

Ultimately, you You can use the specification to add your Blueriq webservice to an API store so that it can be consumed easily by other parties. Use the OpenAPI import in Encore if you wish to use a Blueriq application to consume a Blueriq webservice.

Blueriq REST Services

Most parts in the Blueriq OpenAPI feed are generated automatically based on the model. Other parts have to be added and maintained by the Business Engineer. The table below shows the relation between the Blueriq model in blueriq Encore and its generated OpenAPI feed. In Blueriq Encore, the OpenAPI iconis used to indicate where a description can be added.  

...