crates/api_common/README.md

   1 # lemmy_api_common
   2
   3 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.
   4
   5 Here is an example using [reqwest](https://crates.io/crates/reqwest):
   6
   7 ```rust
   8     let params = GetPosts {
   9         community_name: Some("asklemmy".to_string()),
  10         ..Default::default()
  11     };
  12     let client = Client::new();
  13     let response = client
  14         .get("https://lemmy.ml/api/v3/post/list")
  15         .query(&params)
  16         .send()
  17         .await?;
  18     let json = response.json::<GetPostsResponse>().await.unwrap();
  19     print!("{:?}", &json);
  20 ```
  21
  22 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](https://github.com/LemmyNet/lemmy/blob/main/src/api_routes_http.rs). For the response types you need to look through the crates [lemmy_api](https://github.com/LemmyNet/lemmy/tree/main/crates/api/src) and [lemmy_api_crud](https://github.com/LemmyNet/lemmy/tree/main/crates/api_crud/src) for the place where Perform/PerformCrud is implemented for the parameter type. The response type is specified as a type parameter on the trait.
  23
  24 For a real example of a Lemmy API client, look at [lemmyBB](https://github.com/LemmyNet/lemmyBB/tree/main/src/api).
  25
  26 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).
  27
  28 ## Generate TypeScript bindings
  29
  30 TypeScript bindings (API types) can be generated by running `cargo test --features full`.
  31 The ts files be generated into a `bindings` folder.
  32
  33 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.