schema - Prisma では、どのようにタイプにコメントを追加できますか?

Question

Prisma.io (graphQl) を使用すると、次のようになります。

• ファイル：datamodel.graphql

"""I am a great User"""
type User {
  id: ID! @unique
  email: String! @unique
}

実行後prisma deploy、ファイルからコメントなしでファイルを生成しますdatamodel.graphql

• ファイルgenerated-schema.graphql

type User implements Node {
  id: ID!
  email: String!
}

• プリズマplaygroundにはコメントはありません。

プレイグラウンドでドキュメントを生成するために、どのようにタイプにコメントを追加できますか?

回避策:

チートしてコメントを追加するとgenerated-schema.graphql(このファイルは次の後に上書きされますprisma deploy)

"""I am a great User""" type User implements Node { id: ID! email: String! }

我々は持っています：

関連トピック：

• https://github.com/prisma/graphql-playground/issues/819

• https://www.prisma.io/forum/t/getting-prisma-comments-descriptions-to-appear-in-graphql-playground-schema/2980

• https://github.com/prisma/prisma/issues/2152

Answer 1

Nexusのようなツールはそれを可能にします。オプションの説明は、タイプおよび個々のフィールドとともに含めることができます。

ドキュメントを参照