Base API (Swagger) URL of Core device

[bigman-node-red]

Hi,

The device have the inbuild API description (based on Swagger architecture)

https://localhost/device-dashboard/api-reference

--> Here my question : where is the description file of the Swagger API, usuallly it's a swagger.json ?

Thanks a lot.

PS : here an example, you have the base URL on the top/left : https://petstore.swagger.io/

I look for this base url with the description file....https://petstore.swagger.io/v2/swagger.json

[jochen-scheib · Accepted solution]

Hi bigman-node-red,

you could find the api description files on github, see https://boschrexroth.github.io/rest-api-description/ctrlx-automation/ctrlx-core/index.html (https://github.com/boschrexroth/rest-api-description). There you will also find the corresponding json files. eg. https://boschrexroth.github.io/rest-api-description/ctrlx-automation/ctrlx-core/rexroth-deviceadmin/...

The json files on the device are in the path of the swagger ui and are named openapi.json.

But this path to the json files and api documents are not considered as stable and will change in the future. So it makes more sense to reference the apis from github.

Best regards

Jochen

[bigman-node-red]

Thanks for your reply.

It's perfect to have inbuild in the device the description of the API.

Thanks for the advice for the futur evolution of the API.

Regards