capy-framework 0.10.0

An opinionated full-stack Rust web framework with strong conventions and sensible defaults.
Documentation
//! The normal application factory's OpenAPI is checked against actual wire responses.
#![cfg(feature = "testing")]
use capy_framework::{self as capy, prelude::*, testing::TestApp};

#[derive(Serialize, ApiSchema)]
#[serde(crate = "capy::serde")]
#[schemars(crate = "capy::schema")]
struct Expected {
    id: i32,
    name: String,
}

#[tokio::test]
async fn actual_responses_fail_when_a_field_or_status_drifts() -> Result<()> {
    let good = TestApp::boot(
        App::new().api_routes(
            Routes::new()
                .get("/item", || async { Json(json!({"id": 1, "name": "ok"})) })
                .operation("getItem")
                .response::<Expected>(),
        ),
    )
    .await?;
    good.get("/api/item").send().await.assert_contract();
    good.cleanup().await?;

    let broken = TestApp::boot(
        App::new().api_routes(
            Routes::new()
                .get("/item", || async { Json(json!({"id": 1})) })
                .operation("getItem")
                .response::<Expected>(),
        ),
    )
    .await?;
    let failure = broken
        .get("/api/item")
        .send()
        .await
        .validate_contract()
        .unwrap_err();
    assert!(failure.contains("GET /api/item status 200"), "{failure}");
    assert!(
        failure.contains("$.name: missing required field"),
        "{failure}"
    );
    broken.cleanup().await?;

    let unexpected = TestApp::boot(
        App::new().api_routes(
            Routes::new()
                .get("/item", || async {
                    (
                        capy::axum::http::StatusCode::CONFLICT,
                        Json(json!({"message": "conflict"})),
                    )
                })
                .operation("getItem")
                .response::<Expected>(),
        ),
    )
    .await?;
    let failure = unexpected
        .get("/api/item")
        .send()
        .await
        .validate_contract()
        .unwrap_err();
    assert!(failure.contains("undocumented status 409"), "{failure}");
    unexpected.cleanup().await?;
    Ok(())
}