api-bones 4.0.0

Opinionated REST API types: errors (RFC 9457), pagination, health checks, and more
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

//! Query parameter types for list endpoints.
//!
//! Demonstrates `SortParams`, `SortDirection`, `FilterParams`,
//! `FilterEntry`, and `SearchParams`.
//!
//! Run: `cargo run --example query_params`

use api_bones::{FilterEntry, FilterParams, SearchParams, SortDirection, SortParams};

fn main() {
    // -- Sorting --
    println!("=== Sorting ===");
    let sort_asc = SortParams::asc("created_at");
    let sort_desc = SortParams::desc("price");
    println!(
        "SortParams::asc(\"created_at\"): sort_by={}, direction={:?}",
        sort_asc.sort_by, sort_asc.direction
    );
    println!(
        "SortParams::desc(\"price\"):     sort_by={}, direction={:?}",
        sort_desc.sort_by, sort_desc.direction
    );
    println!("Default SortDirection: {:?}", SortDirection::default());

    // -- Filtering --
    println!("\n=== Filtering ===");
    let filters = FilterParams::new(vec![
        FilterEntry {
            field: "status".into(),
            operator: "eq".into(),
            value: "active".into(),
        },
        FilterEntry {
            field: "price".into(),
            operator: "gt".into(),
            value: "100".into(),
        },
    ]);
    println!("FilterParams ({} filters):", filters.filters.len());
    println!("  is_empty: {}", filters.is_empty());
    print_json("  ", &filters);

    let empty_filters = FilterParams::default();
    println!(
        "\nEmpty FilterParams: is_empty={}",
        empty_filters.is_empty()
    );

    // -- Full-text search --
    println!("\n=== Search ===");
    let basic_search = SearchParams::new("deluxe suite");
    println!("Basic search:");
    print_json("  ", &basic_search);

    let scoped_search = SearchParams::with_fields("deluxe suite", vec!["name", "description"]);
    println!("\nScoped search (specific fields):");
    print_json("  ", &scoped_search);
}

fn print_json(prefix: &str, value: &impl serde::Serialize) {
    let json = serde_json::to_string_pretty(value).expect("serialization");
    for line in json.lines() {
        println!("{prefix}{line}");
    }
}