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

部署指南序列中当前所在位置(“Optimize”)的示意图。

部署指南序列图,包括以下位置:概述、计划、准备、发布、监视和优化。 当前突出显示了“优化”位置。

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

使用 Pascal 命名法命名实体

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

  • 查询

    • compositeNameEntities
    • compositeNameEntity_by_pk
  • 突变

    • createCompositeNameEntity
    • updateCompositeNameEntity
    • deleteCompositeNameEntity
  • 如果实体映射到存储过程,那么生成的查询或变更将被命名为executeCompositeNameEntity,这将更易于阅读和理解。

命名实体时使用单一形式

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

后续步骤