次の方法で共有


データ API ビルダーでの構成のベスト プラクティス

デプロイ ガイドのシーケンス内の現在の場所 ('Optimize') の図。

次の場所を含む展開ガイドのシーケンスの図: 概要、計画、準備、発行、監視、および最適化。 [最適化] の場所は現在強調表示されています。

この記事には、Data API ビルダーでの構成に関する現在推奨されるベスト プラクティスが含まれています。 この記事には、データ API ビルダー ソリューション用に構成する必要があるすべてを網羅した一覧は含まれていません。

パスカルケースを使用してエンティティに名前を付けます

構成ファイルにエンティティを追加するときは、PascalCasing を使用して、生成された GraphQL 型を読みやすくします。 たとえば、生成された GraphQL スキーマ CompositeNameEntity という名前のエンティティがある場合、次のクエリと変更があります。

  • クエリ

    • compositeNameEntities
    • compositeNameEntity_by_pk
  • ミューテーション

    • createCompositeNameEntity
    • updateCompositeNameEntity
    • deleteCompositeNameEntity
  • エンティティがストアド プロシージャにマップされている場合、生成されたクエリまたは変更には executeCompositeNameEntity という名前が付けられます。読みやすくなります。

エンティティに名前を付けるときに単数形を使用する

構成ファイルにエンティティを追加するときは、必ず名前に単数形を使用してください。 データ API ビルダーは、そのエンティティのコレクションが返されるたびに、複数形を自動的に生成します。 構成ファイルに手動で追加することで、単数形と複数形を手動で指定することもできます。 詳細については、 GraphQL 構成リファレンスを参照してください

次のステップ