From 270f3b781a7bb96bc79b97639abf2e9a80aa2a60 Mon Sep 17 00:00:00 2001 From: Nutomic Date: Tue, 3 Jan 2023 09:23:41 +0100 Subject: [PATCH] Add documentation for using Lemmy API from Rust (#2639) --- crates/api_common/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 crates/api_common/README.md diff --git a/crates/api_common/README.md b/crates/api_common/README.md new file mode 100644 index 00000000..df8b2f84 --- /dev/null +++ b/crates/api_common/README.md @@ -0,0 +1,27 @@ +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::().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](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. + +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). -- 2.44.1