24 releases

0.7.0-rc.1 Jun 2, 2024
0.6.0 Dec 15, 2023
0.5.0 Apr 3, 2023
0.5.0-alpha.3 Feb 20, 2023
0.2.2 Jun 22, 2021

#852 in Web programming

Download history 10/week @ 2024-03-13 3/week @ 2024-03-20 28/week @ 2024-03-27 40/week @ 2024-04-03 25/week @ 2024-04-10 3/week @ 2024-04-17 11/week @ 2024-04-24 13/week @ 2024-05-01 6/week @ 2024-05-15 41/week @ 2024-05-22 121/week @ 2024-05-29 290/week @ 2024-06-05 125/week @ 2024-06-12 168/week @ 2024-06-19 75/week @ 2024-06-26

670 downloads per month
Used in 2 crates

GPL-3.0-or-later

61KB
1K SLoC

mwapi

crates.io docs.rs docs (main) pipeline status coverage report

A MediaWiki API client library.

mwapi is a low-level library for the MediaWiki Action API. If you intend to edit pages or want a higher-level interface, it's recommended to use mwbot, which builds on top of this crate.

Goals

  • generic to fit any application, whether for interactive usage or writing a bot
  • fully compatible with concurrent use cases
  • turns MediaWiki errors into Rust errors for you
  • logging (using the tracing crate) for visiblity into errors
  • follow all best practices

Quick start

let client = mwapi::Client::builder("https://en.wikipedia.org/w/api.php")
    .set_user_agent("mwapi demo")
    // Provide credentials for login:
    // .set_botpassword("username", "password")
    .build().await?;
let resp = client.get_value(&[
    ("action", "query"),
    ("prop", "info"),
    ("titles", "Taylor Swift"),
]).await?;
let info = resp["query"]["pages"][0].clone();
assert_eq!(info["ns"].as_u64().unwrap(), 0);
assert_eq!(info["title"].as_str().unwrap(), "Taylor Swift");

Functionality

  • authentication, using OAuth2 (recommended) or BotPasswords
  • error handling, transforming MediaWiki errors into Rust ones
  • CSRF token handling with post_with_token
  • rate limiting and concurrency controls
  • file uploads (needs upload feature)

See also

  • mwbot provides a higher level interface to interacting with MediaWiki
  • mwapi_responses is a macro to generate strict types for dynamic API queries

Contributing

mwapi is a part of the mwbot-rs project. We're always looking for new contributors, please reach out if you're interested!

License

This crate is released under GPL-3.0-or-later. See COPYING for details.

Dependencies

~6–21MB
~277K SLoC