数据 API 生成器中的配置最佳做法

本文包括数据 API 生成器中当前建议的配置最佳做法。 本文不包含为数据 API 生成器解决方案配置的所有内容的详尽列表。

使用 Pascal 命名法的大写格式命名实体

将实体添加到配置文件时，请使用 PascalCasing，以便生成的 GraphQL 类型更易于读取。 例如，如果你有一个名为CompositeNameEntity的实体，则生成的 GraphQL 架构具有以下查询和变更操作：

• 查询

  • compositeNameEntities
  • compositeNameEntity_by_pk

• 突变

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• 如果实体映射到存储过程，生成的查询或突变将被命名为executeCompositeNameEntity，这样更易于理解。

命名实体时使用单一形式

将实体添加到配置文件时，请确保使用名称的单数形式。 每当返回该实体的集合时，数据 API 生成器都会自动生成复数形式。 还可以通过手动将它们添加到配置文件来手动提供单数和复数形式。 有关详细信息，请参阅 GraphQL 配置参考。

后续步骤