lemmy_api_common

Crates.iolemmy_api_common
lib.rslemmy_api_common
version0.19.4-rc.6
sourcesrc
created_at2021-07-24 11:27:53.63134
updated_at2024-06-04 12:58:35.782059
descriptionA link aggregator for the fediverse
homepagehttps://join-lemmy.org/
repositoryhttps://github.com/LemmyNet/lemmy
max_upload_size
id426727
size137,567
(Nutomic)

documentation

https://join-lemmy.org/docs/en/index.html

README

lemmy_api_common

This crate provides all the data types which are necessary to build a client for Lemmy. You can use them with the HTTP client of your choice.

Here is an example using reqwest:

    let params = GetPosts {
        community_name: Some("asklemmy".to_string()),
        ..Default::default()
    };
    let client = Client::new();
    let response = client
        .get("https://lemmy.ml/api/v3/post/list")
        .query(&params)
        .send()
        .await?;
    let json = response.json::<GetPostsResponse>().await.unwrap();
    print!("{:?}", &json);

As you can see, each API endpoint needs a parameter type ( GetPosts), path (/post/list) and response type (GetPostsResponse). You can find the paths and handler methods from this file. The parameter type and response type are defined on each handler method.

For a real example of a Lemmy API client, look at lemmyBB.

Lemmy also provides a websocket API. You can find the full websocket code in this file.

Generate TypeScript bindings

TypeScript bindings (API types) can be generated by running cargo test --features full. The ts files be generated into a bindings folder.

This crate uses ts_rs macros derive(TS) and ts(export) to attribute types for binding generating.

Commit count: 4833

cargo fmt