Skip to main content
Version: pre-release

Annotations

graphql-kotlin-schema-generator ships with a number of annotation classes to allow you to enhance your GraphQL schema for things that can't be directly derived from Kotlin reflection.

  • @GraphQLDescription - Provide a description for a GraphQL field
  • @GraphQLDirective - Registers directive on a GraphQL field
  • @GraphQLIgnore - Exclude field from the GraphQL schema
  • @GraphQLName - Override the name used for the type
  • Kotlin built in @Deprecated - Apply the GraphQL @deprecated directive on the field
  • @GraphQLDeprecated - Apply the GraphQL @deprecated directive but only in the schema, not in your own Kotlin code with @Deprecated
  • @GraphQLType - Allows specifying a return type that is not the Kotlin code