Документация на верхнем уровне схемы GraphQL

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

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

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

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

Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
Что такое Apollo Client и зачем он нужен?
Что такое Apollo Client и зачем он нужен?
Apollo Client - это полнофункциональный клиент GraphQL для JavaScript-приложений, который упрощает получение, управление и обновление данных в...
1
0
353
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

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

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

Другие вопросы по теме