simple_graphql_query_builder 0.2.2

SDKdartflutter
Platformandroidiosweb

A simple GraphQl query builder to generate query as String, used together with the package `graphql`

A Simple Query builder for GraphQl API calls.

Features

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

NameIn Example QueryRequirementNote
name$episodeMust match GraphQl schema
typeEpisodeMust match GraphQl schemaIf required, use Episode!
schemaNameepisodeMust match GraphQl schemaDefault value is derived from param name
defaultValueJEDINoneIf empty, nothing happens

QueryBuilderType

NameDesc
queryUse for query calls
mutationUse for mutation calls

QueryBuilder

NameIn Example QueryRequirementNote
queryNameHeroNameAndFriendsCan be anything you wantDefault value will be taken from param name
nameheroMust match the GraphQl
typequeryMust be type QueryBuilderTypeRefer to QueryBuilderType
variables($episode: Episode = JEDI) and (episode: $episode)Must be type QueryVariableRefer to QueryVariable
fieldsname friends { name }Map of fieldsCan use together with toJson()