restless

REST API wrappers with less pain. This trait exposes helper traits that let you define your API in terms of trait implementations. Useful to remove redundant code if you use Rust on the backend and then frontend. Similar to standards such as OpenAPI, but uses the Rust trait system. The trait implementation gives you API clients for free.

Examples

If you build a useful type that encapsulates all information about your REST request, such as this:

/// GET /api/v1/users/:name/documents/:id
pub struct UserDocument {
    user: String,
    document: Uuid,
}

Then you can implement the GetRequest trait for this type and use the RequestMethod marker.

use restless::{GetRequest, method::Get};

impl GetRequest for UserDocument {
    type Response = Json<Document>;
    type Query = ();

    fn path(&self) -> Cow<'_, str> {
        format!("api/v1/users/{}/documents/{}", self.user, self.document).into()
    }

    fn query(&self) -> Self::Query {}
}

impl RequestMethod for UserDocument {
    type Method = Get<Self>;
}

Now you can make this kind of request using the built-in clients.

Clients

This crate offers integrations with the following HTTP clients and frameworks by enabling the corresponding feature:

License

MIT, see LICENSE.md

lib.rs:

restless query

This crate implements several strategies to encode query parameters mechanically from Rust structs. As a consumer of restless, you should not be using this crate directly, but rather the restless crate and activate the features there.