vantage-api-client 1.0.0

Vantage extension for REST and GraphQL HTTP API backends
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

//! Vista bridge for the REST API backend.
//!
//! Construct a `Vista` from a typed `Table<RestApi, E>` via
//! `RestApi::vista_factory().from_table(...)`. The factory harvests
//! schema metadata (columns, id field, references) and wraps the
//! erased table in a `RestApiTableShell` that the universal Vista
//! surface drives.
//!
//! A YAML spec builds the same way through `build_from_spec`, and its
//! `references:` traverse to other models through the factory's registry
//! or an installed [`ModelResolver`].
//!
//! The shell only reads: it counts, lists and fetches by id, and
//! advertises absolute-offset windows and ordering where the API is
//! configured for them. Writes go through [`RestApi::http_request`].

pub mod factory;
mod source;
pub mod spec;

pub use factory::{ModelResolver, RestApiVistaFactory};
pub use source::RestApiTableShell;
pub use spec::{
    ApiColumnExtras, ApiReferenceExtras, ApiTableBlock, ApiTableExtras, RestApiVistaSpec,
};

use crate::RestApi;

impl RestApi {
    /// Return a Vista factory bound to this REST API data source.
    pub fn vista_factory(&self) -> RestApiVistaFactory {
        RestApiVistaFactory::new(self.clone())
    }
}