Crates.io | lemmy_api_common |
lib.rs | lemmy_api_common |
version | 0.19.8-beta.0 |
source | src |
created_at | 2021-07-24 11:27:53.63134 |
updated_at | 2024-12-04 14:17:13.117638 |
description | A link aggregator for the fediverse |
homepage | https://join-lemmy.org/ |
repository | https://github.com/LemmyNet/lemmy |
max_upload_size | |
id | 426727 |
size | 142,744 |
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(¶ms)
.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.
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.