@Version(value="1.0")

Package org.eclipse.microprofile.graphql

APIs for building a code-first GraphQL endpoint, for example:

See: Description

Interface Summary

Interface	Description
ConfigKey	Holding all available config keys

Enum Summary

Enum	Description
GraphQLException.ExceptionType

Exception Summary

Exception	Description
GraphQLException	A GraphQLException is used to pass error information back to the client.

Annotation Types Summary

Annotation Type	Description
DateFormat	Annotation provides way how to set custom date format to field or JavaBean property.
DefaultValue	Controls the mapping of a method's parameter to an argument of a GraphQL operation (query/mutation/subscription).
Description	Sets the description in the GraphQL schema for the target field, type, parameter, etc.
Enum	Maps of the annotated Java enum to a GraphQL enum.
GraphQLApi	Marks a class as a GraphQL Endpoint.
Id	Marks a field as a ID Scalar Type.
Ignore	Excludes an otherwise mapped element.
Input	Maps the annotated class to a GraphQL input type.
Interface
Mutation	Specifies that the annotated method provides the implementation (ie.
Name	Allows users to name a field or argument in the GraphQL Schema For example, a user might annotate a method's parameter as such:
NonNull	Specifies that the GraphQL type and/or input type represented by the Java field this annotation is applied to must be marked as non-null in the schema.
NumberFormat	Annotation provides way how to set custom number format to field or JavaBean property.
Query	Specifies that the annotated method provides the implementation (ie.
Source	Extends a GraphQL type by adding an externally defined field, effectively enabling a graph to be assembled.
Type	Maps of the annotated Java class to a GraphQL type.

Package org.eclipse.microprofile.graphql Description

APIs for building a code-first GraphQL endpoint, for example:

 public class CharacterService {
      @Query("friendsOf")
      @Description("Returns all the friends of a character")
     public List <Character > getFriendsOf(Character character) {
         // ... 
     }
 }
 

Since:

1.0