lino-rest-api 0.2.1

REST API framework and client using Links Notation (LINO) instead of JSON
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

//! A REST API framework and client that speak Links Notation instead of JSON.
//!
//! Everything the HTTP standards expect of a REST service — content negotiation,
//! conditional requests, problem details, collection pagination, automatic
//! `HEAD`/`OPTIONS`/`405`, CORS, a service description and an OpenAPI document —
//! is provided out of the box, with LINO as the default wire format and JSON as
//! a fallback. The wire protocol is defined in `docs/spec/README.md`, and the
//! JavaScript, Python and Rust packages speak it byte for byte alike, so the
//! three implementations produce the same entity tags.

// Every fallible operation in this crate reports a `LinoHttpError`, because that
// is what becomes a problem details response. It is larger than clippy's
// threshold for an error type, and boxing it at every call site would cost more
// in noise than it saves in moved bytes.
#![allow(clippy::result_large_err)]

pub mod app;
pub mod client;
pub mod codec;
pub mod collection;
pub mod cors;
pub mod description;
pub mod etag;
pub mod headers;
pub mod media_type;
pub mod middleware;
pub mod problem;
pub mod query;
pub mod request;
pub mod resource;
pub mod response;
pub mod router;
pub mod serve;
pub mod store;
pub mod value;

// The surface the JavaScript and Python packages export, re-exported at the
// crate root so that the three libraries are used the same way. Everything
// remains available through its module for code that prefers the longer path.
pub use app::{DESCRIPTION_PATH, LinoApp, OPENAPI_PATH, RawRequest, create_lino_app};
pub use client::{LinoClient, LinoClientError, LinoResponse, RequestOptions, create_lino_client};
pub use codec::{
    decode, decode_from, decode_single_line, encode, encode_compact_notation, encode_for,
    encode_single_line,
};
pub use cors::CorsPolicy;
pub use description::ServiceInfo;
pub use media_type::{
    JSON_CONTENT_TYPE, LINO_COMPACT_CONTENT_TYPE, LINO_CONTENT_TYPE, LINO_LINE_CONTENT_TYPE,
};
pub use middleware::ResponseParts;
pub use problem::LinoHttpError;
pub use request::LinoRequest;
pub use resource::ResourceOptions;
pub use response::{LinoResult, accepted, created, no_content, ok, raw_response, status};
pub use serve::{BoundServer, serve};
pub use store::{MemoryStore, Store};
pub use value::{array, boolean, int, object, string};