foundry-rs 0.6.1

Configuration-driven REST backend library for Rust with PostgreSQL — define schemas, tables, and APIs in JSON, get a production-grade REST service.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Entity CRUD routes built from resolved model.
//! Uses parameterized paths so Path extractors receive the segment and id; handlers resolve the entity by path.
//! Unprefixed routes use the default/active model; /package/:package_id/... use that package's model (same entity names, different packages).

use crate::handlers::asset::sign_asset;
use crate::handlers::entity::{
    archive, archive_package, bulk_create, bulk_create_package, bulk_update, bulk_update_package,
    create, create_package, delete as delete_handler, delete_package, list, list_history,
    list_package, read, read_history_version, read_package, unarchive, unarchive_package, update,
    update_package,
};
use crate::handlers::extensible_fields::{
    apply_indexes_handler, delete_registry_handler, get_indexes, get_registry, put_registry,
};
use crate::handlers::kv::{kv_delete, kv_get, kv_list_keys, kv_put};
use crate::state::AppState;
use axum::{routing::get, routing::post, Router};

pub fn entity_routes(state: AppState) -> Router {
    Router::new()
        // /assets/sign must be declared before /:path_segment to avoid being captured.
        .route("/assets/sign", get(sign_asset))
        .route("/:path_segment", get(list).post(create))
        .route("/:path_segment/bulk", post(bulk_create).patch(bulk_update))
        // Static second segment — takes precedence over /:path_segment/:id (like /bulk).
        .route(
            "/:path_segment/extensible-fields",
            get(get_registry)
                .put(put_registry)
                .delete(delete_registry_handler),
        )
        .route(
            "/:path_segment/extensible-fields/indexes",
            get(get_indexes).post(apply_indexes_handler),
        )
        .route(
            "/:path_segment/:id",
            get(read).patch(update).delete(delete_handler),
        )
        .route("/:path_segment/:id/archive", post(archive))
        .route("/:path_segment/:id/unarchive", post(unarchive))
        .route("/:path_segment/:id/history", get(list_history))
        .route(
            "/:path_segment/:id/history/:version",
            get(read_history_version),
        )
        .route("/package/:package_id/kv/:namespace", get(kv_list_keys))
        .route(
            "/package/:package_id/kv/:namespace/:key",
            get(kv_get).put(kv_put).delete(kv_delete),
        )
        .route(
            "/package/:package_id/:path_segment",
            get(list_package).post(create_package),
        )
        .route(
            "/package/:package_id/:path_segment/bulk",
            post(bulk_create_package).patch(bulk_update_package),
        )
        .route(
            "/package/:package_id/:path_segment/:id",
            get(read_package)
                .patch(update_package)
                .delete(delete_package),
        )
        .route(
            "/package/:package_id/:path_segment/:id/archive",
            post(archive_package),
        )
        .route(
            "/package/:package_id/:path_segment/:id/unarchive",
            post(unarchive_package),
        )
        .with_state(state)
}

#[cfg(test)]
mod route_tests {
    use axum::{routing::get, Router};

    async fn noop() -> &'static str {
        ""
    }

    /// matchit panics at build time on conflicting routes. This proves the static
    /// `extensible-fields` segment coexists with the `:id` param segment (same pattern as `bulk`).
    #[test]
    fn extensible_fields_route_coexists_with_id_route() {
        let _router: Router = Router::new()
            .route("/:path_segment", get(noop))
            .route("/:path_segment/bulk", get(noop))
            .route("/:path_segment/extensible-fields", get(noop))
            .route("/:path_segment/extensible-fields/indexes", get(noop))
            .route("/:path_segment/:id", get(noop))
            .route("/:path_segment/:id/archive", get(noop));
    }
}