a57658d99c
* add logic to prevent downloading remote pictrs images * apply formatting * Do not attempt a pictrs fetch if the remote image is also on a pictrs instance * Do not attempt a pictrs fetch if the remote image is also on a pictrs instance and cache_federated_images is false * Generalising the no caching option to handle all remote images * rustfmt * Return None if the URL is not an image * Updating defaults.hjson * fixing typo * Fixing typo * Skip cloning the Url unless we need to * using a HEAD request for checking the content type, saving bandwidth/improving perf * Removing early returns * Switching back to GET requests for Content-Type because pictrs does not handle HEAD requests * Simplifying logic and using metadata_image instead of url if we do not get a pictrs thumbnail * Removing unused import * Return None as a thumbnail if caching is disabled * formatting --------- Co-authored-by: Djones4822 <david.jones4822@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| Cargo.toml | ||
| README.md | ||
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 parameter types from this file. For the response types you need to look through the crates lemmy_api and lemmy_api_crud 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.
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.