Рекомендации по настройке в построителе API данных

Схема последовательности руководства по развертыванию, включая следующие расположения: обзор, планирование, подготовка, публикация, мониторинг и оптимизация. В настоящее время выделена опция «Оптимизация».

В этой статье содержатся текущие рекомендации по настройке в построителе API данных. В этой статье не содержится исчерпывающий список всех элементов, которые необходимо настроить для решения построителя API данных.

Именуйте сущности в стиле Pascal

При добавлении сущности в файл конфигурации используйте PascalCasing, чтобы созданные типы GraphQL были проще считывать. Например, если у вас есть сущность с именем CompositeNameEntity, в сгенерированной схеме GraphQL есть следующие запросы и мутации:

• Запросы

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Изменения

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Если сущность сопоставляется с хранимой процедурой, созданный запрос или мутация будет названа executeCompositeNameEntity, что проще и удобнее для чтения.

Использование единственной формы при именовании сущностей

При добавлении сущности в файл конфигурации обязательно используйте единую форму для имени. Конструктор API данных автоматически создает форму множественного числа, когда возвращается коллекция данной сущности. Кроме того, можно вручную указать формы единственного и множественного числа, добавив их в файл конфигурации. Дополнительные сведения см. в справочнике по конфигурации GraphQL.

Следующий шаг

Рекомендации по обеспечению безопасности