History

Nutomic 86b44c2a4d Add site.content_warning, local_site.default_post_listing_mode (#4393 ) * Include local_site.content_warning setting for showing nsfw by default * Add community setting `only_followers_can_vote` * clippy * add auto_expand_images site setting * cleanup * add missing api params * postquery/communityquery changes * clippy * change error * replace auto_expand_images with default_site_post_listing_mode * change post/community query params * get rid of only_followers_can_vote * machete * fix * clippy * revert remaining vote changes * remove dead code * remove unused var * fmt		2024-02-16 07:24:35 -05:00
..
src	Add site.content_warning, local_site.default_post_listing_mode (#4393 )	2024-02-16 07:24:35 -05:00
Cargo.toml	Rewrite images to use local proxy (#4035 )	2024-01-25 09:22:11 -05:00
README.md	Get rid of remaining Perform/SendActivity traits (fixes #3670 ) (#3926 )	2023-09-05 05:33:46 -04:00

README.md

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.