1 release (0 unstable)
2.0.0-rc.1 | Mar 3, 2023 |
---|
#2383 in Web programming
1MB
18K
SLoC
mangadex-api
Important
This git repo is just a fork from gondolyr/mangadex-api but the project and crate has been yanked so will now maintain this crate for special-eureka and eureka-manager
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.
Disclaimer
mangadex-api
is not affiliated with MangaDex.
Table of Contents
- Requirements
- How to install
- Dependency Justification
- Features
- HTTP Client
- Response Structs
- Getting Started
- Using a custom reqwest Client
- Searching manga by title
- Downloading chapter pages
- Downloading a manga's main cover image
- Changelog
- License
- Contributing
Requirements
How to install
Add mangadex-api
to your dependencies:
[dependencies]
# ...
mangadex-api = "2.0.0-rc.1"
If you are using cargo-edit
, run
cargo add mangadex-api
Dependency Justification
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 |
Features
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:
mangadex-api = { version = "2.0.0-rc.1", features = ["multi-thread"] }
HTTP Client
The mangadex_api::MangaDexClient
is asynchronous, using
reqwest
as the HTTP client.
Response Structs
The response structs can be found in the schemas
module and contain the fields in a JSON response.
Getting Started
This example demonstrates how to fetch a random manga.
use mangadex_api::v5::MangaDexClient;
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let client = MangaDexClient::default();
let random_manga = client
.manga()
.random()
.build()?
.send()
.await?;
println!("{:?}", random_manga);
Ok(())
}
Using a custom reqwest Client
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.
use reqwest::Client;
use mangadex_api::v5::MangaDexClient;
# async fn run() -> anyhow::Result<()> {
let reqwest_client = Client::builder()
.timeout(std::time::Duration::from_secs(10))
.build()?;
let client = MangaDexClient::new(reqwest_client);
# Ok(())
# }
Searching manga by title
Reference: https://api.mangadex.org/swagger.html#/Manga/get-search-manga
use mangadex_api::v5::MangaDexClient;
# async fn run() -> anyhow::Result<()> {
let client = MangaDexClient::default();
let manga_results = client
.manga()
.search()
.title("full metal")
.build()?
.send()
.await?;
println!("manga results = {:?}", manga_results);
# Ok(())
# }
Searching manga by title with reference expansion
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:
- https://api.mangadex.org/docs/reference-expansion/
- Endpoint: https://api.mangadex.org/swagger.html#/Manga/get-search-manga
- Author object: https://api.mangadex.org/swagger.html#/Author/get-author-id
use mangadex_api::types::{ReferenceExpansionResource, RelationshipType};
use mangadex_api::v5::schema::RelatedAttributes;
use mangadex_api::v5::MangaDexClient;
# async fn run() -> anyhow::Result<()> {
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 = manga_results.data.iter().filter_map(|manga| {
for rel in &manga.relationships {
if rel.type_ == RelationshipType::Author {
return Some(rel);
}
}
None
});
for author in authors {
if let Some(RelatedAttributes::Author(author_attributes)) = &author.attributes {
println!("{} - {}", author.id, author_attributes.name);
}
}
# Ok(())
# }
Downloading chapter pages
Reference: https://api.mangadex.org/docs/reading-chapter/
// 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;
# async fn run() -> anyhow::Result<()> {
let client = MangaDexClient::default();
let chapter_id = Uuid::new_v4();
let at_home = client
.at_home()
.server()
.chapter_id(&chapter_id)
.build()?
.send()
.await?;
let http_client = reqwest::Client::new();
// Original quality. Use `.data.attributes.data_saver` for smaller, compressed images.
let page_filenames = at_home.chapter.data;
for filename in page_filenames {
// If using the data-saver option, use "/data-saver/" instead of "/data/" in the URL.
let page_url = at_home
.base_url
.join(&format!(
"/{quality_mode}/{chapter_hash}/{page_filename}",
quality_mode = "data",
chapter_hash = at_home.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);
}
# Ok(())
# }
Downloading a manga's main cover image
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.
// 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 mangadex_api::types::RelationshipType;
use mangadex_api::v5::MangaDexClient;
use mangadex_api::CDN_URL;
# async fn run() -> anyhow::Result<()> {
let client = MangaDexClient::default();
let manga_id = Uuid::new_v4();
let manga = client
.manga()
.get()
.manga_id(&manga_id)
.build()?
.send()
.await?;
let cover_id = manga
.data
.relationships
.iter()
.find(|related| related.type_ == RelationshipType::CoverArt)
.expect("no cover art found for manga")
.id;
let cover = client
.cover()
.get()
.cover_id(&cover_id)
.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 cover_url = Url::parse(&format!(
"{}/covers/{}/{}",
CDN_URL, manga_id, cover.data.attributes.file_name
))
.unwrap();
let http_client = reqwest::Client::new();
let res = http_client.get(cover_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);
# Ok(())
# }
Changelog
The changelog can be found here.
Changes are added manually to keep the changelog human-readable with summaries of the changes from each version.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
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.
Contributing
We welcome contributions from everyone. There are many ways to contribute and the CONTRIBUTING.md document explains how you can contribute and get started.
Dependencies
~5–17MB
~256K SLoC