README.md

Go Simple API Project

This project made to combine some pretty beautiful thing together

This project is using

• net/http as http server
• gorilla/mux as router
• Sentry as APM
• sirupsen/logrus as base of logging
• ilyakaznacheev/cleanenv for managing configurations
• slok/go-http-metrics as middleware for exporting prometheus metrics
• rs/cors as middleware for CORS
• mvrilo/go-redoc for redoc view
• rapi-doc/RapiDoc for RapiDoc view instead of swagger
• go-playground/validator as base of validation

Project files structure

• logger: package for logging on top of sirupsen/logrus with option to sent logs to Sentry
• httpHandlers: all of the http handlers should be here
• httpServer: http server components are here ready to use
• type: every type that we want every where should be here
• configuration: on top of ilyakaznacheev/cleanenv this will manage our configurations with a simple function that returns a variable with Configuration struct
• air: executable version of cosmtrek/air is here to help you with live reloading you code (configuration for that is present here)
• validator: package for validating our things

TODO

Moved to GitHub Project