simple_graphql_query_builder 0.2.2

simple_graphql_query_builder: ^0.2.2 copied to clipboard

A Simple Query builder for GraphQl API calls.

Features #

• A simple GraphQl Query builder
• Can be used with simple_graphql_query_builder_gen to help with query result generations.

Usage #

Sample usage #

final query = QueryBuilder(
    queryName: 'HeroAndFriends',
    name: 'hero',
    type: QueryBuilderType.query,
    variables: [
        QueryVariable(name: 'episode', type: 'Episode!', defaultValue: 'JEDI'),
    ],
    fields: {
        'name': null,
        'friends': {
            'name': null,
        }
    },
).build();

Will result in the following query

query HeroNameAndFriends($episode: Episode = JEDI) {
  hero(episode: $episode) {
    name
    friends {
      name
    }
  }
}

Note

You can you .toJson() or .toMap() from library such as json_serializable for fields, for example:

class Hero {
  final String? name;

  const Hero({this.name});

  Map<String, dynamic> toJson() {
    return {
      'name': this.name,
    }
  }
}

final query = QueryBuilder(
    queryName: 'HeroAndFriends',
    name: 'hero',
    type: QueryBuilderType.query,
    variables: [
        QueryVariable(name: 'episode', type: 'Episode!', defaultValue: 'JEDI'),
    ],
    fields: Hero(name: 'xyz').toJson(),
).build();

Usage with graphql package #

query is derived from QueryBuilder from the example above

final QueryResult result = await client.query(query);

Arguments #

QueryVariable #

QueryBuilderType #

QueryBuilder #