4e69153e3e
git-subtree-dir: packages/graphql git-subtree-mainline:ac29392d7fgit-subtree-split:33e2f86ba7
50 lines
No EOL
1.4 KiB
Markdown
50 lines
No EOL
1.4 KiB
Markdown
# graphql_generator
|
|
[](https://pub.dartlang.org/packages/graphql_generator)
|
|
[](https://travis-ci.org/angel-dart/graphql)
|
|
|
|
Generates `package:graphql_schema` schemas for
|
|
annotated class.
|
|
|
|
Replaces `convertDartType` from `package:graphql_server`.
|
|
|
|
## Usage
|
|
Usage is very simple. You just need a `@graphQLClass` or `@GraphQLClass()` annotation
|
|
on any class you want to generate an object type for.
|
|
|
|
Individual fields can have a `@GraphQLDocumentation()` annotation, to provide information
|
|
like descriptions, deprecation reasons, etc.
|
|
|
|
```dart
|
|
@graphQLClass
|
|
class Todo {
|
|
String text;
|
|
|
|
@GraphQLDocumentation(description: 'Whether this item is complete.')
|
|
bool isComplete;
|
|
}
|
|
|
|
void main() {
|
|
print(todoGraphQLType.fields.map((f) => f.name));
|
|
}
|
|
```
|
|
|
|
The following is generated (as of April 18th, 2019):
|
|
|
|
```dart
|
|
// GENERATED CODE - DO NOT MODIFY BY HAND
|
|
|
|
part of 'main.dart';
|
|
|
|
// **************************************************************************
|
|
// _GraphQLGenerator
|
|
// **************************************************************************
|
|
|
|
/// Auto-generated from [Todo].
|
|
final GraphQLObjectType todoGraphQLType = objectType('Todo',
|
|
isInterface: false,
|
|
interfaces: [],
|
|
fields: [
|
|
field('text', graphQLString),
|
|
field('isComplete', graphQLBoolean)
|
|
]);
|
|
``` |