mirror of
https://github.com/LemmyNet/lemmy.git
synced 2024-11-22 14:45:10 +00:00
34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
# lemmy_api_common
|
|
|
|
This crate provides all the data types which are necessary to build a client for [Lemmy](https://join-lemmy.org/). You can use them with the HTTP client of your choice.
|
|
|
|
Here is an example using [reqwest](https://crates.io/crates/reqwest):
|
|
|
|
```rust
|
|
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](https://github.com/LemmyNet/lemmy/blob/main/src/api_routes_http.rs). The parameter type and response type are defined on each handler method.
|
|
|
|
For a real example of a Lemmy API client, look at [lemmyBB](https://github.com/LemmyNet/lemmyBB/tree/main/src/api).
|
|
|
|
Lemmy also provides a websocket API. You can find the full websocket code in [this file](https://github.com/LemmyNet/lemmy/blob/main/src/api_routes_websocket.rs).
|
|
|
|
## 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`](https://docs.rs/ts-rs/6.2.1/ts_rs/#traits) macros `derive(TS)` and `ts(export)` to attribute types for binding generating.
|