Trait Endpoint

Source

pub trait Endpoint {
    type Response: DeserializeOwned;
    type Params: EndpointParams + Default;
    type Query: EndpointQuery + Default;
    type Body: EndpointBody + Default;
    type Headers: EndpointHeaders + Default;

    const METHOD: Method;
    const PATH: &'static str;
}

Expand description

Describes a typed API route.

Implement this trait (or use [endpoint!]) and call Client::call.

Compile-time enforcement: EndpointParams can require .params() via NeedsParams. EndpointBody can require a body via NeedsBody on POST routes. EndpointQuery only types query values — .query() is optional even when Query is not [()]; the Default bound is for struct construction, not auto-apply on send.

§Examples

define_params!(GetTodoParams for "/todos/:id" { id: u64 });

struct GetTodo;

impl Endpoint for GetTodo {
    const METHOD: Method = Method::GET;
    const PATH: &'static str = "/todos/:id";
    type Response = Todo;
    type Params = GetTodoParams;
    type Query = ();
    type Body = ();
    type Headers = ();
}

#[derive(Deserialize)]
struct Todo { id: u64, title: String }

let client = Client::new("https://jsonplaceholder.typicode.com")?;
let todo: Todo = client
    .call::<GetTodo>()
    .params(GetTodoParams { id: 1 })
    .send_json()
    .await?;