自定义graphql操场生成的文档

时间:2019-12-03 15:37:46

标签: graphql

我正在尝试做与这个graphQL游乐场演示中实现的类似的事情。

https://www.graphqlbin.com/v2/6RQ6TM

当您进入文档时,可以在此处看到对这些自定义类型进行了注释:screenshot of graphql playground demo showing custom annotations

但是,当我在网上环顾四周时,我找不到实际的操作方法。我试着在npm模块中查找以查看生成的位置,但无济于事。我真的很想能够向此文档中添加其他信息。你们有人有什么主意吗?

预先感谢

1 个答案:

答案 0 :(得分:1)

您看到的只是这些类型的description属性。您可以将那些直接添加到您的架构中:

"A person is an individual person or character within the Star Wars universe."
type Person {
  id: ID!
}

如果需要多行,也可以使用块字符串:

"""
A person is an individual person or character
within the Star Wars universe.
"""
type Person {
  id: ID!
}

或者,如果以编程方式编写模式,则只需添加适当的属性即可:

const Person = new GraphQLObject({
  name: 'Person',
  description: 'A person is an individual person or character within the Star Wars universe.',
  fields: () => {...},
})