Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

'Healthcheck' endpoint on the API - requested by customer #202

Open
pacharanero opened this issue Feb 10, 2024 · 0 comments
Open

'Healthcheck' endpoint on the API - requested by customer #202

pacharanero opened this issue Feb 10, 2024 · 0 comments
Assignees
Labels
feature-request New feature or request

Comments

@pacharanero
Copy link
Member

pacharanero commented Feb 10, 2024

One of our larger customers has requested that there be a 'healthcheck' endpoint which they can use to verify the API is working, this will be called approximtely once per minute and should just return a "200 OK" response which is enough for their systems to ascertain the API is available.

This is fairly easy to implement in FastAPI and would be a good issue for anyone wanting to learn more about FastAPI. We already have the root / response returning the openAPI3 spec so I would pick something like /health/ and return a 200 OK and the current time on the server (to help prevent caching, or at least to make it obvious if caching is going on)

Here's some background info on the idea of healthcheck APIs https://microservices.io/patterns/observability/health-check-api.html

@pacharanero pacharanero added the feature-request New feature or request label Feb 10, 2024
@pacharanero pacharanero self-assigned this Feb 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant