filename:
html/api/services/health/read.md
branch:
main
back to repo
this API route does the following:
basic reachability check
db connectivity check
auth check
usage: curl -i http://localhost:8080/api/health/ping
expected response:
{
"ping": {"status":"ok"},
"db": {"status":"ok"},
"auth": {"status":"ok"},
}
router: "ok" if router reachable.
db: "ok" for query success or "error" message.
auth: "ok" means at least one active API key exists;
use this service as an example for how to connect to db, add endpoints, and use this framework