Struct HealthResponse 

pub struct HealthResponse {
    pub status: &'static str,
    /* private fields */
}

A minimal health-check response body.

Serializes as { "status": "ok" } and responds with 200 OK.

Use HealthResponse::degraded or HealthResponse::unhealthy for non-nominal states.

Example

use axum::response::IntoResponse;
use axum_api_kit::HealthResponse;

async fn health() -> impl IntoResponse {
    HealthResponse::ok()
}

Fields

status: &'static str

Implementations

impl HealthResponse

pub const fn ok() -> Self

Returns a HealthResponse with status = "ok" and HTTP 200 OK.

pub const fn degraded() -> Self

Returns a HealthResponse with status = "degraded" and HTTP 200 OK.

Use when the service is reachable but operating in a reduced capacity (e.g., a non-critical dependency is down).

pub const fn unhealthy() -> Self

Returns a HealthResponse with status = "unhealthy" and HTTP 503 Service Unavailable.

Use when the service cannot fulfill requests normally (e.g., the primary database is unreachable).

Trait Implementations

impl Clone for HealthResponse

fn clone(&self) -> HealthResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComposeSchema for HealthResponse

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for HealthResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IntoResponse for HealthResponse

fn into_response(self) -> Response

Create a response.

impl Serialize for HealthResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for HealthResponse

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.