Документация на верхнем уровне схемы GraphQL - PullRequest
1 голос
/ 25 июня 2019

Я документирую все свои типы, поля и параметры в моей схеме (SDL), включая Query и Mutation вверху - но я не могу понять, как добавить один фрагмент документации для верхний уровень всей схемы.

Я не уверен, что это спецификация или инструментарий - например, Apollo позволяет мне писать schema { }, но не помещать в него что-либо или документацию до него.

И нет примеров этого в документах, особенно на https://graphql.github.io/graphql-spec/June2018/#sec-Descriptions,, где показана «хорошо описанная» схема без строки документа верхнего-верхнего уровня.

Это то, что спецификация не покрывает, или просто набор инструментов?

1 Ответ

1 голос
/ 25 июня 2019

В отличие от типов, SchemaDefinition spec не содержит Description.Тип интроспекции __Schema также не имеет поля description.Таким образом, нет никакого способа установить или получить описание для всей схемы.

Это, однако, предстоящая функция .

...