# README

web

Helpers para montar servicios de APIs usando gin-gonic

Uso

go get github.com/architecture-it/go-platform/web

Ejemplos

import (
    "github.com/architecture-it/go-platform/web"
    "github.com/gin-gonic/gin"
    "net/http"
)

func main() {
    
    //Espera $PORT, por default usará el 8080.
    server:= web.NewServer(web.ReadConfigFromEnv()) 
    server.AddMetrics() // /metrics de los requests en formato prometheus 
    server.AddCorsAllOrigins()

    //Agrego los HealthCheckers que necesito
    server.AddHealth(health.IbmMQHealthChecker, health.MysqlHealthChecker, ...)

    // apidocs con la documentacion de openApi que se especifique
    server.AddApiDocs("https://raw.githubusercontent.com/architecture-it/proyecto/openapi.yaml")

    r := server.GetRouter()
    r.GET("/ping", func (c *gin.Context) {
        c.String(http.StatusOK,"pong")
    })

    server.ListenAndServe()
}

# Functions

DefaultConfig crea una Config default que escucha en 8080.
No description provided by the author
NewServer crea un server nuevo con la config indicada.
ReadConfigFromEnv lee la config de las vars de entorno.$PORT: el puerto donde se expone el server.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Config para los parametros de config del server.
Server un server http basado en gin-gonic.
No description provided by the author

# Type aliases

No description provided by the author