https://github.com/arthurkhlghatyan/gql-client-rs

Minimal GraphQL client for Rust.
https://github.com/arthurkhlghatyan/gql-client-rs

crate graphql rust-lang

Last synced: about 2 months ago
JSON representation

Minimal GraphQL client for Rust.

• Host: GitHub
• URL: https://github.com/arthurkhlghatyan/gql-client-rs
• Owner: arthurkhlghatyan
• License: mit
• Created: 2020-12-02T02:21:19.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T14:30:03.000Z (5 months ago)
• Last Synced: 2024-11-16T04:54:59.435Z (about 2 months ago)
• Topics: crate, graphql, rust-lang
• Language: Rust
• Homepage: https://bit.ly/2JWZR1v
• Size: 31.3 KB
• Stars: 48
• Watchers: 4
• Forks: 16
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# gql_client

Minimal GraphQL client for Rust

[![Build Status](https://travis-ci.com/arthurkhlghatyan/gql-client-rs.svg?branch=master)](https://travis-ci.com/arthurkhlghatyan/gql-client-rs)

[![crates.io](https://img.shields.io/crates/v/gql_client.svg)](https://crates.io/crates/gql_client)

[![docs](https://docs.rs/gql_client/badge.svg)](https://docs.rs/gql_client/latest/gql_client/)

* Simple API, supports queries and mutations

* Does not require schema file for introspection

* Supports WebAssembly

# Basic Usage

* Use client.query_with_vars for queries with variables

* There's also a wrapper client.query if there is no need to pass variables

 ```rust

use gql_client::Client;

use serde::{Deserialize, Serialize};

#[derive(Deserialize)]

pub struct Data {

    user: User

}

#[derive(Deserialize)]

pub struct User {

    id: String,

    name: String

}

#[derive(Serialize)]

pub struct Vars {

    id: u32

}

#[tokio::main]

async fn main() -> Result<(), Box> {

    let endpoint = "https://graphqlzero.almansi.me/api";

    let query = r#"

        query UserByIdQuery($id: ID!) {

            user(id: $id) {

                id

                name

            }

        }

    "#;

    let client = Client::new(endpoint);

    let vars = Vars { id: 1 };

    let data = client.query_with_vars::(query, vars).await.unwrap();

    println!("Id: {}, Name: {}", data.unwrap().user.id, data.unwrap().user.name);

    Ok(())

}

```

# Passing HTTP headers

Client exposes new_with_headers function to pass headers

using simple HashMap<&str, &str>

 ```rust

use gql_client::Client;

use std::collections::HashMap;

#[tokio::main]

async fn main() -> Result<(), Box> {

    let endpoint = "https://graphqlzero.almansi.me/api";

    let mut headers = HashMap::new();

    headers.insert("authorization", "Bearer ");

    let client = Client::new_with_headers(endpoint, headers);

    Ok(())

}

 ```

# Error handling

There are two types of errors that can possibly occur. HTTP related errors (for example, authentication problem)

or GraphQL query errors in JSON response.

Debug, Display implementation of GraphQLError struct properly displays those error messages.

Additionally, you can also look at JSON content for more detailed output by calling err.json()

 ```rust

use gql_client::Client;

use serde::{Deserialize, Serialize};

#[derive(Deserialize)]

pub struct Data {

    user: User

}

#[derive(Deserialize)]

pub struct User {

    id: String,

    name: String

}

#[derive(Serialize)]

pub struct Vars {

    id: u32

}

#[tokio::main]

async fn main() -> Result<(), Box> {

    let endpoint = "https://graphqlzero.almansi.me/api";

    // Send incorrect request

    let query = r#"

        query UserByIdQuery($id: ID!) {

            user(id: $id) {

                id1

                name

            }

        }

    "#;

    let client = Client::new(endpoint);

    let vars = Vars { id: 1 };

    let error = client.query_with_vars::(query, vars).await.err();

    println!("{:?}", error);

    Ok(())

}

 ```