org.springframework.graphql.data.method.annotation

Annotation Type SchemaMapping

@Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Documented
public @interface SchemaMapping

Annotation to express a mapping to a GraphQL type and field pair. Typically used on methods, but also possible to use at the class level to specify a default type name for all handler methods.

Since:

1.0.0

Author:

Rossen Stoyanchev

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	field Customize the name of the GraphQL field to bind to.
String	typeName Customizes the name of the parent/container type for the GraphQL field.
String	value Effectively an alias for field().

Element Detail

field

@AliasFor(value="value")
public abstract String field

Customize the name of the GraphQL field to bind to.

By default, if not specified, this is initialized from the method name.

Default:

""

value

@AliasFor(value="field")
public abstract String value

Effectively an alias for field().

Default:

""

typeName

public abstract String typeName

Customizes the name of the parent/container type for the GraphQL field.

By default, if not specified, it is derived from the class name of a source argument injected into the handler method.

This attributed is supported at the class level and at the method level! When used on both levels, the one on the method level overrides the one at the class level.

Default:

""