The mangadex-api crate provides a convenient, high-level wrapper
client for the MangaDex API,
written in Rust.
It covers all public endpoints covered by their documentation.
Documentation (Project main branch)
Please note that as MangaDex is still in beta, this SDK will be subject to sudden breaking changes.
mangadex-api is not affiliated with MangaDex.
Add mangadex-api to your dependencies:
```toml [dependencies]
mangadex-api = "2.0.0-rc.1" ```
If you are using cargo-edit, run
bash
cargo add mangadex-api
| Dependency | Used for | Included |
|:---------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:-----------|
| anyhow | Capturing unexpected errors. | always |
| clap | Examples demonstrating the library's capabilities | dev builds |
| derive_builder | Conveniently generating setters for the API endpoint builders. | always |
| fake | Generating random data for unit tests. | dev builds |
| futures | Async request processing. | always |
| reqwest | Making HTTP requests to the MangaDex API. | always |
| serde | Se/dese/rializing HTTP response bodies into structs. | always |
| serde_json | Creating JSON objects for unit tests. | dev builds |
| serde_qs | Query string serialization for HTTP requests. | always |
| thiserror | Customized error handling. | always |
| time | Convenience types for handing time fields. | always |
| tokio | Async runtime to handle futures (not the library) in the examples. | dev builds |
| url | Convenient Url type for validating and containing URLs. | always |
| uuid | Convenient Uuid type for validating and containing UUIDs for requests and responses. Also used to randomly generate UUIDs for testing. | always |
| wiremock | HTTP mocking to test the MangaDex API. | dev builds |
All features are not included by default. To enable them, add any of the following to your project's Cargo.toml file.
multi-thread
Enable the MangaDexClient to be thread-safe, at the cost of operations being slightly more expensive.
For example, to enable the multi-thread feature, add the following to your Cargo.toml file:
toml
mangadex-api = { version = "2.0.0-rc.1", features = ["multi-thread"] }
The mangadex_api::MangaDexClient is asynchronous, using
reqwest as the HTTP client.
The response structs can be found in the schemas module and contain the fields in a JSON response.
This example demonstrates how to fetch a random manga.
```rust use mangadex_api::v5::MangaDexClient;
async fn main() -> anyhow::Result<()> { let client = MangaDexClient::default();
let random_manga = client
.manga()
.random()
.build()?
.send()
.await?;
println!("{:?}", random_manga);
Ok(())
} ```
By default, mangadex_api::MangaDexClient will use the default
reqwest::Client settings.
You may provide your own reqwest::Client to customize options such as the
request timeout.
```rust use reqwest::Client;
use mangadex_api::v5::MangaDexClient;
let reqwestclient = Client::builder() .timeout(std::time::Duration::fromsecs(10)) .build()?;
let client = MangaDexClient::new(reqwest_client);
```
Reference: https://api.mangadex.org/swagger.html#/Manga/get-search-manga
```rust use mangadex_api::v5::MangaDexClient;
let client = MangaDexClient::default();
let manga_results = client .manga() .search() .title("full metal") .build()? .send() .await?;
println!("manga results = {:?}", manga_results);
```
Every fetch will include all relationships but with minimal information such as the relationship type and ID. Reference expansion will include the full JSON object in the results for the types that are added to the request.
In the example below, any associated authors in the list of relationships will provide detailed information such as the author's name, biography, and website in the results.
References:
```rust use mangadexapi::types::{ReferenceExpansionResource, RelationshipType}; use mangadexapi::v5::schema::RelatedAttributes; use mangadex_api::v5::MangaDexClient;
let client = MangaDexClient::default();
let manga_results = client .manga() .search() .title("full metal") .include(&ReferenceExpansionResource::Author) .build()? .send() .await?;
println!("manga results = {:?}", manga_results);
let authors = mangaresults.data.iter().filtermap(|manga| { for rel in &manga.relationships { if rel.type_ == RelationshipType::Author { return Some(rel); } }
None
});
for author in authors { if let Some(RelatedAttributes::Author(authorattributes)) = &author.attributes { println!("{} - {}", author.id, authorattributes.name); } }
```
Reference: https://api.mangadex.org/docs/reading-chapter/
```rust // Imports used for downloading the pages to a file. // They are not used because we're just printing the raw bytes. // use std::fs::File; // use std::io::Write;
use reqwest::Url; use uuid::Uuid;
use mangadex_api::v5::MangaDexClient;
let client = MangaDexClient::default();
let chapterid = Uuid::newv4();
let athome = client .athome() .server() .chapterid(&chapterid) .build()? .send() .await?;
let http_client = reqwest::Client::new();
// Original quality. Use .data.attributes.data_saver for smaller, compressed images.
let pagefilenames = athome.chapter.data;
for filename in pagefilenames {
// If using the data-saver option, use "/data-saver/" instead of "/data/" in the URL.
let pageurl = athome
.baseurl
.join(&format!(
"/{qualitymode}/{chapterhash}/{pagefilename}",
qualitymode = "data",
chapterhash = athome.chapter.hash,
page_filename = filename
))
.unwrap();
let res = http_client.get(page_url).send().await?;
// The data should be streamed rather than downloading the data all at once.
let bytes = res.bytes().await?;
// This is where you would download the file but for this example,
// we're just printing the raw data.
// let mut file = File::create(&filename)?;
// let _ = file.write_all(&bytes);
println!("Chunk: {:?}", bytes);
}
```
While this example could directly get the cover information by passing in the cover ID, it is not often that one would have the ID off-hand, so the most common method would be from a manga result.
If you want to get all of a manga's cover images, you will need to use the cover list endpoint
and use the manga[] query parameter.
```rust // Imports used for downloading the cover to a file. // They are not used because we're just printing the raw bytes. // use std::fs::File; // use std::io::Write;
use reqwest::Url; use uuid::Uuid;
use mangadexapi::types::RelationshipType; use mangadexapi::v5::MangaDexClient; use mangadexapi::CDNURL;
let client = MangaDexClient::default();
let mangaid = Uuid::newv4(); let manga = client .manga() .get() .mangaid(&mangaid) .build()? .send() .await?;
let coverid = manga .data .relationships .iter() .find(|related| related.type == RelationshipType::CoverArt) .expect("no cover art found for manga") .id; let cover = client .cover() .get() .coverid(&coverid) .build()? .send() .await?;
// This uses the best quality image. // To use smaller, thumbnail-sized images, append any of the following: // // - .512.jpg // - .256.jpg // // For example, "https://uploads.mangadex.org/covers/8f3e1818-a015-491d-bd81-3addc4d7d56a/4113e972-d228-4172-a885-cb30baffff97.jpg.512.jpg" let coverurl = Url::parse(&format!( "{}/covers/{}/{}", CDNURL, mangaid, cover.data.attributes.filename )) .unwrap();
let http_client = reqwest::Client::new();
let res = httpclient.get(coverurl).send().await?; // The data should be streamed rather than downloading the data all at once. let bytes = res.bytes().await?;
// This is where you would download the file but for this example, we're just printing the raw data. // let mut file = File::create(&filename)?; // let _ = file.write_all(&bytes); println!("Chunk: {:?}", bytes);
```
The changelog can be found here.
Changes are added manually to keep the changelog human-readable with summaries of the changes from each version.
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
We welcome contributions from everyone. There are many ways to contribute and the CONTRIBUTING.md document explains how you can contribute and get started.