Skip to main content

fastapi_healthcheck_uri

A module to have a FastAPI HealthCheck reach out to a URI to validate external service health.

Adding Health Checks

Here is what you need to get started.

from fastapi import FastAPI
from fastapi_healthcheck import HealthCheckFactory, healthCheckRoute
from fastapi_healthcheck_uri import HealthCheckUri

app = FastAPI()

# Add Health Checks
_healthChecks = HealthCheckFactory()
_healthChecks.add(
    HealthCheckUri(
        alias='reddit', 
        connectionUri="https://www.reddit.com/r/aww.json", 
        tags=('external', 'reddit', 'aww'),
        healthyCode=200,
        unhealthyCode=500
    )
)
app.add_api_route('/health', endpoint=healthCheckRoute(factory=_healthChecks))

Metadata

Release files for fastapi-healthcheck-uri 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fastapi-healthcheck-uri 0.1.0
File Size Uploaded
fastapi_healthcheck_uri-0.1.0.tar.gz 2.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for fastapi-healthcheck-uri 0.1.0
File Interpreter ABI Platform
fastapi_healthcheck_uri-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 5.9 kB

Release files / fastapi_healthcheck_uri-0.1.0.tar.gz

Download URL fastapi_healthcheck_uri-0.1.0.tar.gz
Size 2.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3a570c92bb42efe37746470395b4c7a24619e10257ecdb8ef9f3c60b39959580
BLAKE2b-256 checksum
How to use checksums
a26469b02f6771256b5009ecebb92302baf8f6e4af430d0b07f8878b5519c047
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.12 CPython/3.9.9 Darwin/20.6.0

Release files / fastapi_healthcheck_uri-0.1.0-py3-none-any.whl

Download URL fastapi_healthcheck_uri-0.1.0-py3-none-any.whl
Size 3.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e2a6a86faf1857f2cf90dbc1a3a538a3049b5897b534607eb28fafaf2565ef63
BLAKE2b-256 checksum
How to use checksums
7562cf8c881ebfa1061e506d6938836a6acf7b629ef53af38cdaaf53c3fd947c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.12 CPython/3.9.9 Darwin/20.6.0

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page