API REST Backend for a personal budget tracker.
It also has the goal to implement engineering best practices and new technologies for study purposes.
The backend supports both HTTP/1.1 (with optional TLS) and HTTP/2 (with mandatory TLS) protocols. You can simply play with both hc.InitHTTPServer() and InitHTTP2Server() methods for each one of the protocols at the main.go file.
You can use docker-compose to run the entire backend stack locally: budget-tracker and mongodb (with an initial admin user created)
The mongodb served by docker-compose has no credentials so it's recommended only for development purposes.
The "observability" stack containing: jaeger and prometheus is optional but recommended for testing purposes. You can either disable them by commenting on the services at docker-compose.yml or simply specifying which service you are going to need: docker-compose up -d budget-tracker.
This application uses go-swagger to generate swagger specs directly from the code, to run it just:
make swagger-spec
The output will be a local ./docs/swagger.yaml file which can be used along with external applications such as insomnia designer. In the case of side-by-side UI containers such as swagger-ui you can serve the following endpoint: /swagger.yaml
Download ./docs/insomnia.json file and upload it to your insomnia application to get all endpoints to be tested
This application supports opentelemetry and currently uses jaeger exporter, stdout, and zipkin exporters are supported as well.
We are supporting prometheus' /metrics endpoint in order to be posterior scraped by a third-party application. It contains business metrics and additional automatic HTTP ones, the Go Collector metrics are currently disabled.