test

Documentation

Index

• type ApiHandler
  • func NewApiHandler(httpClient *http.Client) *ApiHandler
  • func (h *ApiHandler) Weather(ctx echo.Context) error
• type ForecastLocation
• type ForecastSummary
• type Handler
  • func NewHandler() *Handler
  • func (h *Handler) Live(ctx echo.Context) error
  • func (h *Handler) Ready(ctx echo.Context) error
• type ServiceHealth
• type ServiceHealthDescription
• type ServiceHealthStatus
• type WeatherForecast

Types

type ApiHandler

type ApiHandler struct {
	HttpClient *http.Client
}

func NewApiHandler

func NewApiHandler(httpClient *http.Client) *ApiHandler

func (*ApiHandler) Weather

func (h *ApiHandler) Weather(ctx echo.Context) error

Weather fetches the latest weather forecast for Amsterdam.

@Summary Weather forecast @Description Performs an external api call to get weather forecast @Tags weather @ID weather-forecast @Produce json @Success 200 {object} WeatherForecast "OK" @Failure 503 {object} WeatherForecast "Service Unavailable" @Router /weather/amsterdam [get]

type ForecastLocation

type ForecastLocation string // @name forecastLocation

ForecastLocation defines the location of the weather forecast.

type ForecastSummary

type ForecastSummary string // @name forecastSummary

ForecastSummary the specifics of the weather forecast.

type Handler

type Handler struct{}

Handler defines the http router implementation for health endpoints.

func NewHandler

func NewHandler() *Handler

NewHandler creates a new Handler for health endpoints.

func (*Handler) Live

func (h *Handler) Live(ctx echo.Context) error

Live performs a live check.

@Summary Live healthcheck @Description Performs a live check @Tags health @ID health-live @Produce json @Success 200 {object} ServiceHealth "OK" @Failure 503 {object} ServiceHealth "Service Unavailable" @Router /health/live [get]

func (*Handler) Ready

func (h *Handler) Ready(ctx echo.Context) error

Ready performs readiness check.

@Summary Ready healthcheck @Description Performs readiness check @Tags health @ID health-ready @Success 200 "OK" @Failure 503 {object} ServiceHealth "Service Unavailable" @Router /health/ready [get]

type ServiceHealth

type ServiceHealth struct {
	ServiceStatus ServiceHealthStatus      `json:"status"`
	Description   ServiceHealthDescription `json:"description"`
	CompletedAt   time.Time                `json:"completed_at"`
}

ServiceHealth defines the health of the service.

type ServiceHealthDescription

type ServiceHealthDescription string // @name serviceHealthDescription

ServiceHealthDescription describes the state of the service status.

type ServiceHealthStatus

type ServiceHealthStatus string // @name serviceHealthStatus

ServiceHealthStatus defines the status of the service.

type WeatherForecast

type WeatherForecast struct {
	Location ForecastLocation `json:"location"`
	Summary  ForecastSummary  `json:"summary"`

} // @name WeatherForecast

WeatherForecast provides information about the weather