API Fabric для представления схемы GraphQL и обозревателя схем
Схема GraphQL, основанная на языке определения схемы GraphQL (SDL), определяет формат данных, предоставляемых в API. Это уровень абстракции, который обеспечивает гибкость для потребителей при скрытии сведений о реализации серверной части. Схема основана на коллекции типов объектов, содержащих поля.
Представление схемы
Чтобы получить доступ к представлению схемы, выберите схему в левом нижнем углу экрана разработки данных. В представлении показана текстовая версия SDL GraphQL с созданными типами, полями и операциями.
На следующем рисунке представлен пример представления схемы, включая обширный список объектов, доступных в этой схеме.
Примечание.
Представление схемы доступно только для чтения. В обозревателе схем можно изменять только объекты.
Обозреватель схем
Обозреватель схем находится в области слева, а также доступен при использовании редактора в представлении запроса. Обозреватель позволяет пользователям быстро визуализировать доступные типы и поля, а также запросы и изменения, определенные в API.
Все типы GraphQL, доступные из объектов, которые вы выбираете при подключении к источнику данных, отображаются в списке обозревателя схем. Типы отображаются под именем источника данных, из которого они были производными. На следующем рисунке вы увидите тип SalesOrderDetail, производный от таблицы SalesOrderDetail в конечной точке аналитики SQL AdventureWorks.
В дополнение к типам API Fabric для GraphQL автоматически создает запросы и изменения для любых новых объектов, которые вы выбираете для предоставления.
В нашем примере AdventureWorks расширение списка запросов отображает автоматически созданные запросы для источника данных.
Чтобы просмотреть изменения, автоматически созданные API, разверните узел мутаций в дереве обозревателя схем.
Изменение объектов с помощью обозревателя схем
Обозреватель схем можно использовать для изменения объектов после создания API. В следующем примере мы выбираем многоточие рядом с типом SalesOrderDetail , производным от базы данных AdventureWorks :
Для типов доступны следующие параметры:
- Обновление схемы — позволяет обновлять схему новыми объектами из источника данных.
- Переименование — изменяет имя объекта. Обратите внимание: это изменение влияет только на схему API и не влияет на исходный объект источника данных, из которого он был производным.
- Удаление из схемы — эффективно удаляет объект из схемы GraphQL, чтобы вы больше не могли ссылаться на нее.
- Управление связями — позволяет вам управлять отношениями. Дополнительные сведения см. в разделе "Управление связями" в API Fabric для GraphQL.
- Свойства — отображает дополнительные сведения об объекте.
Включение и отключение запросов и мутаций
Функция включения и отключения запросов и изменений предоставляет администраторам и разработчикам детальный контроль доступа к API и использования. Он позволяет выборочно активировать или деактивировать определенные запросы и изменения в схеме GraphQL. Это позволяет динамически управлять возможностями API, не изменяя код или развертывая изменения.
Запросы и изменения в обозревателе схем имеют два дополнительных варианта:
- Отключить . Запрещает выполнение запроса или изменения запросов. При попытке выполнения возвращается ошибка. После отключения запроса или изменения схемы происходит перезагрузка схемы, а запрос или мутация отображаются серым цветом в обозревателе схем.
- Включение — повторно включите ранее отключенный запрос или мутацию. Выполнение элемента сразу же доступно после операции перезагрузки схемы, которая выполняется после выбора параметра "Включить ".
Обратите внимание, что автоматически созданные из хранимых процедур запросы или изменения могут быть удалены только. После удаления их можно повторно добавить с помощью параметров получения данных или схемы обновления.