Как мы можем добавить комментарий к типу с помощью Prisma?

С 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! }

у нас есть:  введите описание изображения здесь

Похожие темы:


person Alan    schedule 30.12.2018    source источник


Ответы (2)


Ответ здесь: 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

person Alan    schedule 30.12.2018

Такие инструменты, как Nexus, позволяют это. Необязательные описания могут быть включены вместе с типами и отдельными полями.

Ссылка на документы

person Pavel Ye    schedule 22.07.2019