server

Documentation

Index

• func GetConfig(key string) (string, error)
• func Liveness(c *gin.Context)
• func Product(c *gin.Context)
• func Products(c *gin.Context)
• func Readiness(c *gin.Context)
• func Run(ctx context.Context)

Functions

func GetConfig

func GetConfig(key string) (string, error)

func Liveness

func Liveness(c *gin.Context)

Liveness is a simple endpoint to check if the server is alive @Summary Get liveness status of the microservice @Description Get liveness status of the microservice @Tags Kubernetes @Success 200 {string} string @Router /live [get]

func Product

func Product(c *gin.Context)

Product returns a product from the database @Summary Get a product @Description Get a product @Tags Products @Produce json @Param id path string true "Product ID" @Success 200 {object} object @Failure 400 {string} string @Failure 500 {string} string @Router /v1/{id} [get]

func Products

func Products(c *gin.Context)

Products returns a list of products from the database @Summary Get a list of products @Description Get a list of products @Tags Products @Produce json @Success 200 {array} object @Failure 400 {string} string @Failure 500 {string} string @Router /v1/all [get]

func Readiness

func Readiness(c *gin.Context)

Readiness is a simple endpoint to check if the server is ready @Summary Get readiness status of the microservice @Description Get readiness status of the microservice @Tags Kubernetes @Success 200 {string} string @Failure 503 {string} string @Router /ready [get]

func Run

func Run(ctx context.Context)