simple_graphql_query_builder

Description:

simple graphql query builder

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();
copied to clipboard
Will result in the following query
query HeroNameAndFriends($episode: Episode = JEDI) {
hero(episode: $episode) {
name
friends {
name
}
}
}
copied to clipboard
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,
}
}
}
copied to clipboard
final query = QueryBuilder(
queryName: 'HeroAndFriends',
name: 'hero',
type: QueryBuilderType.query,
variables: [
QueryVariable(name: 'episode', type: 'Episode!', defaultValue: 'JEDI'),
],
fields: Hero(name: 'xyz').toJson(),
).build();
copied to clipboard

Usage with graphql package #
query is derived from QueryBuilder from the example above
final QueryResult result = await client.query(query);
copied to clipboard

Arguments #
QueryVariable #



Name
In Example Query
Requirement
Note




name
$episode
Must match GraphQl schema



type
Episode
Must match GraphQl schema
If required, use Episode!


schemaName
episode
Must match GraphQl schema
Default value is derived from param name


defaultValue
JEDI
None
If empty, nothing happens



QueryBuilderType #



Name
Desc




query
Use for query calls


mutation
Use for mutation calls



QueryBuilder #



Name
In Example Query
Requirement
Note




queryName
HeroNameAndFriends
Can be anything you want
Default value will be taken from param name


name
hero
Must match the GraphQl



type
query
Must be type QueryBuilderType
Refer to QueryBuilderType


variables
($episode: Episode = JEDI) and (episode: $episode)
Must be type QueryVariable
Refer to QueryVariable


fields
name friends { name }
Map of fields
Can use together with toJson()