Data API 建構器中的設定最佳實務

部署指南序列中目前位置(「優化」)的示意圖。

部署指南順序的圖表,包括這些位置,依序排列:概觀、計劃、準備、發佈、監視和優化。 「優化」位置目前已被標示。

本文包含目前推薦的 Data API 建構器配置最佳實務。 本文並未列出你必須為資料 API 建構方案設定的所有事項。

使用 Pascal 套管命名實體

在將實體加入設定檔時,請使用 PascalCasing,讓產生的 GraphQL 類型更易閱讀。 例如,若你有一個名為 CompositeNameEntity GraphQL 的實體,生成的 GraphQL 架構包含以下查詢與變異:

  • 查詢

    • compositeNameEntities
    • compositeNameEntity_by_pk
  • 突變

    • createCompositeNameEntity
    • updateCompositeNameEntity
    • deleteCompositeNameEntity
  • 如果實體映射到儲存程序,產生的查詢或變異會被命名 executeCompositeNameEntity為 ,這樣更容易且更易閱讀。

命名實體時請使用單數形式

在將實體加入設定檔時,務必使用單數形式作為名稱。 Data API 建構器會在回傳該實體集合時自動產生複數形式。 你也可以手動提供單數和複數形式,並手動加入設定檔。 欲了解更多資訊,請參閱 GraphQL 設定參考。

下一個步驟