lacoctelera::routes

Module health

Source
Expand description

Module that implements an endopint for health checks.

§Description

Two endpoints are available:

  • echo for a basic ping support with public access.
  • health_check for a detailed health report with restricted access.

The number of requests within a time frame to both endpoints are limited by the API to every client. This is a mechanism to prevent DoS attacks to the server. Every response includes the header Retry-After to inform the client when it is allowed to send a new request to the API.

Structs§

  • HealthResponse
    Struct that holds status information of the running instance of the application.
  • echo
    Ping endpoint for the API (Public).
  • health_check
    Health status endpoint for the API (Restricted).
  • options_echo
    Options method for the /echo endpoint.
  • options_health
    Options method for the /health endpoint.

Enums§