History

Dessalines 8c0c1628e0 Adding a vector indexing check to prevent panics. Fixes #2753 (#2754 ) * Adding a vector indexing check to prevent panics. Fixes #2753 * Fixing for new clippy lint. * Externalizing get_top_mod check. Adding get_first clippy lint * Removing unit tests get(0)s * Fixing some firsts manually		2023-02-28 12:34:50 +01:00
..
src	Adding a vector indexing check to prevent panics. Fixes #2753 (#2754 )	2023-02-28 12:34:50 +01:00
Cargo.toml	Organize utils into separate files. Fixes #2295 (#2736 )	2023-02-16 05:05:14 +01:00
README.md	Add documentation for using Lemmy API from Rust (#2639 )	2023-01-03 03:23:41 -05: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 parameter types from this file. For the response types you need to look through the crates lemmy_api and lemmy_api_crud for the place where Perform/PerformCrud is implemented for the parameter type. The response type is specified as a type parameter on the trait.

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.