66a63df152
* Instance blocks with mod log entry and expiration (fixes #2506) * separate table for instance block mod log * fix tests * fix ts * modlog entry for allow instance * fix test cleanup * add back test * clippy * fix check * more changes * move files * update * sql fmt * partly working * fix setup * cleanup * fixes * prettier * try catch * address comments |
||
---|---|---|
.. | ||
src | ||
Cargo.toml | ||
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(¶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.
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.