Provides an
/health
endpoint response with the health of the app in the Spring Boot format.Usage
app.get('/health', require('@maxdome/health').controller({
example: () => {},
}));
Example response
{
"example": { status: "UP" },
"status":"UP"
}
Plugins
- Check with HTTP requests:
health-got
Swagger
paths:
/health:
get:
summary: "Healthcheck if the app is running correctly"
responses:
200:
description: "OK"
schema:
type: object
properties:
status:
type: string
example: "UP"
500:
description: "Internal Server Error"