Osvědčené postupy konfigurace v Tvůrci rozhraní Data API

Diagram posloupnosti průvodce nasazením, včetně těchto umístění, v uvedeném pořadí: Přehled, Plán, Příprava, Publikování, Monitorování a Optimalizace Umístění s názvem „Optimalizovat“ je aktuálně zvýrazněno.

Tento článek obsahuje aktuální doporučené osvědčené postupy pro konfiguraci v Tvůrci rozhraní Data API. Tento článek neobsahuje úplný seznam všech položek, které musíte pro řešení Tvůrce rozhraní API pro data nakonfigurovat.

Pojmenování entit pomocí casingu Pascal

Při přidávání entity do konfiguračního souboru použijte PascalCasing, aby generované typy GraphQL byly čitelnější. Pokud máte například entitu s názvem CompositeNameEntity vygenerované schéma GraphQL, má následující dotazy a změny:

• Queries

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutace

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Pokud se entita mapuje na uloženou proceduru, vygenerovaný dotaz nebo mutace by byl pojmenován executeCompositeNameEntity, což je jednodušší a elegantnější pro čtení.

Použití jednotného formuláře při pojmenování entit

Při přidávání entity do konfiguračního souboru nezapomeňte pro název použít jednotný formulář. Tvůrce rozhraní DATA API automaticky vygeneruje formulář v množném čísle pokaždé, když se vrátí kolekce dané entity. Můžete také ručně zadat jednotná a množná čísla jejich přidáním do konfiguračního souboru. Další informace najdete v tématu Referenční informace o konfiguraci GraphQL.

Další krok

osvědčené postupy zabezpečení