feat: Add swagger UI

[patriciareinoso]

Description

This PR adds a service for swagger UI docs.
This is an optional functionality, default behavior is not changed.

The swagger UI for the API documentation is automatically generated from annotations.

How to use it:

To generate the swagger UI files run:

swag init -g backend/webui_service/swagger_ui_service.go --outputTypes go

The docs.go file will automatically be created in webconsole/docs

The swagger UI runs by default on localhost. If the webconsole server runs remotely, set the following environment variable.

export WEBUI_ENDPOINT=<webconsole-ip>:5000

Build the webconsole including the UI option:

make webconsole-ui

Access the swagger UI at:

http://<webconsole-ip>:5000/swagger/index.html

The doc.json file, which can be integrated in a frontend implementation, is available at:

http://<webconsole-ip>:5000/swagger/doc.json

Documentation for code annotations

https://github.com/swaggo/swag

Rationale

Swagger UI provides interactive API documentation where developers can see available endpoints, their parameters, and expected responses. They can also test endpoints directly from the documentation interface, making it easier to understand and use the API.

[thakurajayL]

Do you welcome comments in draft status?

[gatici]

Looks Good.

[gab-arrobo]

@patriciareinoso please rebase your PR. Thanks!