View specification via Swagger

View specification in console via Swagger:

  1. Open the console of the virtual machine;

  2. Run the command (root privileges required):

    docker cp hw-fh_f_engine_1:/usr/src/app/swagger_server/swagger/swagger.yaml Apiary-swagger.yml

View specification in console via Swagger UI:

Note: in current version the backend API is insecure when using it without platform front-end services (f_deck on Apiary). It will be fixed in future versions. Currently, we strongly recommend you not to use these settings if you are not sure that they are safe. In any case, you should not open the ports below to the whole world.

To get an API specification using Swagger UI, open access to the back-end service (f_engine on Apiary):

  1. Open the console of the virtual machine;

  2. Open the file /opt/hw-fh/config/user.ini (root privileges required):

    nano /opt/hw-fh/config/user.ini

  3. Add the following parameters to the file and specify the ports:

    [main]
f.engine.port.expose = 5001
f.engine.ip.expose = 127.0.0.1

Note: you may use port number 0.0.0.0 instead of 127.0.0.1 only if you are sure that your virtual machine is on an isolated network. Otherwise, we recommend using an SSH tunnel to the machine where Apiary platform is running.

  1. Save the file /opt/hw-fh/config/user.ini;

  2. To apply changes, run the command:

    /opt/hw-fh/bin/reconfig

  3. Open browser on the page: http://<IP-address>:5001/api/ui/

See also