使用 Prisma,我们如何为类型添加评论?
Posted
技术标签:
【中文标题】使用 Prisma,我们如何为类型添加评论?【英文标题】:With Prisma, How can we add a comment for a Type? 【发布时间】:2019-05-27 05:55:30 【问题描述】:使用 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
,我没有评论。
我们如何为 Type 添加注释以便在 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
【问题讨论】:
【参考方案1】:答案在这里: https://www.prisma.io/forum/t/comments-in-prisma-graphql-from-datamodel-graphql/4330/2?u=alan345
Currently, there’s no easy way to resolve this. This is an open feature request, which you can learn more about here:
https://github.com/prisma/prisma/issues/2152
【讨论】:
【参考方案2】:Nexus 等工具允许这样做。可选描述可以与类型和单个字段一起包含。
Ref to docs
【讨论】:
以上是关于使用 Prisma,我们如何为类型添加评论?的主要内容,如果未能解决你的问题,请参考以下文章