Graphql ademas de auto generar la documentacion de cada tipo y de tiparla sus datos, nos permite agregar una descripcion de cada campo e incluso una descripcion para cada tipo o mutacion!
Basta con solo sobre el campo, el tipo o mutacion entre comillas dobles escribir nuestras descripciones.
"This is the product data shape of platzi store, we can specify as much as we want . . . "
type Product {
"Auto generated Id"
id: ID!
"Name of the product"
name:String!
"Price of the product in the store"
price: Float!
"A brief description about the product"
description: String!
"Contains the url of an image about the product"
image: String!
"Stores the product creation date"
createdAt: String!
}
type Mutation {
"Allows to create a new product in the store using Graphql"
addProduct(dto: CreateProductDto!): Product
}
Y esto se veria reflejado de esta manera en nuestro playground de Graphql:
Definitivamente le da un toque mas pulido a nuestra api el tener todas sus funcionalidades bien documentadas :su
¿Quieres ver más aportes, preguntas y respuestas de la comunidad?