byo-graphql 0.1.1

simple bring-your-own graphql client
Documentation

MIT Latest Version docs Chat on Miaou

A simple "bring your own queries and types" GraphQL client.

Design Principles

  • I want to use my own Rust structures and not have them generated by macros
  • I want to use my own queries and not have them generated by macros
  • I want to manage queries as strings in my Rust code
  • I don't know what I'm doing

How to use it

The github example demonstrates querying GitHub's GraphQL API to get the number of stars of a repository.

First create a client, that you may keep and reuse:

let mut graphql_client = GraphqlClient::new("https://api.github.com/graphql")?;
graphql_client.set_bearer_auth("your-github-api-token");

You need the structs into which to deserialize the server's answer:

#[derive(Deserialize)]
pub struct Repository {
    stargazers: RepoStargazers,
}
#[derive(Deserialize)]
pub struct RepoStargazers {
    totalCount: usize,
}

And you need a query:

let query = r#"{
	repository(owner: "Canop", name: "bacon") {
	    stargazers {
		totalCount
	    }
	}
}"#;

note: in the example's complete code, the query is dynamically built with format!, as you'll usually do.

You now can fetch and display the data:

let repo: Repository = graphql_client.get_first_item(query)?;
println!("stars: {}", repo.stargazers.totalCount);

Why not use it

  • There's already a popular and well tested GraphQL client in Rust
  • I only tested basic queries, no mutations
  • I don't know what I'm doing