Comment écrire des commentaires dans le fichier de définition de schéma dans GraphQL Java et les refléter dans GraphiQL et GraphQL Playground
Selon API de nouvelle génération pour la création et l'apprentissage du premier service Web GraphQL, lorsque vous commentez chaque schéma dans le fichier de définition de schéma, Il est censé être entouré de trois guillemets comme.
scheme.graphqls
"""Livre"""
type Book {
"""ID"""
id: ID
"""Nom"""
name: String
"""nombre de pages"""
pageCount: Int
"""Auteur"""
author: Author
}
En écrivant comme ci-dessus, le commentaire entre trois guillemets sera affiché dans la Description de GraphiQL et GraphQL Playground. Cependant, en écrivant légèrement GraphQL avec notre Java + Spring Boot, j'ai remarqué que si l'écriture ci-dessus est suffisante, elle ne sera pas reflétée dans GraphiQL et GraphQL Playground, et ce ne sera pas de description.
Par conséquent, je l'ai résolu en mettant # au début comme indiqué ci-dessous.
scheme.graphqls
#Livre
type Book {
# ID
id: ID
#Nom
name: String
#nombre de pages
pageCount: Int
#Auteur
author: Author
}
Si vous vérifiez avec GraphiQL et GraphQL Playground, il s'affichera comme suit.
c'est tout.
Recommended Posts