Générer les signatures des résolveurs GraphQL — Numio

Quand l’utiliser

• Typer l'objet de resolvers passé à Apollo Server ou graphql-yoga pour que parent, args et les valeurs de retour soient vérifiés.
• Obtenir les interfaces DataFetcher de graphql-java pour chaque type avec l'option JAVA Resolvers Signature.

Mode d’emploi

1. Collez le schéma dans l'éditeur GraphQL Schema.
2. Choisissez TypeScript Resolvers Signature, Flow Resolvers Signature ou JAVA Resolvers Signature dans la liste de sortie.
3. Copiez la sortie ; en TypeScript, annotez votre table de resolvers avec le type Resolvers généré.

type Query {
  user(id: ID!): User
}

type User {
  id: ID!
  name: String
}

import { GraphQLResolveInfo } from "graphql"
…
export type QueryResolvers<
  ContextType = any,
  ParentType extends
    ResolversParentTypes["Query"] = ResolversParentTypes["Query"],
> = {
  user?: Resolver<
    Maybe<ResolversTypes["User"]>,
    ParentType,
    ContextType,
    RequireFields<QueryUserArgs, "id">
  >
}

export type UserResolvers<
  ContextType = any,
  ParentType extends
    ResolversParentTypes["User"] = ResolversParentTypes["User"],
> = {
  id?: Resolver<ResolversTypes["ID"], ParentType, ContextType>
  name?: Resolver<Maybe<ResolversTypes["String"]>, ParentType, ContextType>
  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>
}
…

Détails et limites

Les types générés comme QueryResolvers ont ContextType = any ; les arguments obligatoires sont typés avec RequireFields, et les resolvers d'objet incluent un __isTypeOf facultatif.

Seul le schéma est utilisé. Les signatures de resolvers ne dépendent pas des opérations, la page n'a donc pas d'éditeur Documents.

L'option Java produit des public interfaces de méthodes DataFetcher dans public class Resolvers, dans le package com.example.graphql. Tout s'exécute dans un Web Worker du navigateur.

FAQ

Outils associés

Spécifications et références

• GraphQL Code Generator: typescript-resolvers