126 releases

1.0.0-alpha.0 Feb 5, 2025
0.20.0-alpha.5 Feb 4, 2025
0.19.9 Feb 10, 2025
0.19.8 Dec 12, 2024
0.11.3-rc.5 Jul 24, 2021

#1083 in Web programming

Download history 307/week @ 2024-10-26 346/week @ 2024-11-02 347/week @ 2024-11-09 121/week @ 2024-11-16 27/week @ 2024-11-23 108/week @ 2024-11-30 551/week @ 2024-12-07 67/week @ 2024-12-14 15/week @ 2024-12-21 1/week @ 2024-12-28 1/week @ 2025-01-04 4/week @ 2025-01-11 5/week @ 2025-01-18 6/week @ 2025-01-25 622/week @ 2025-02-01 267/week @ 2025-02-08

901 downloads per month
Used in 10 crates (9 directly)

AGPL-3.0

2.5MB
60K SLoC

Rust 31K SLoC // 0.0% comments SQL 29K SLoC // 0.0% comments

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/v4/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.

Dependencies

~14–53MB
~1M SLoC