Metodtips för konfiguration i Data API Builder

Den här artikeln innehåller de aktuella rekommenderade metodtipsen för konfiguration i data-API-byggaren. Den här artikeln innehåller inte en fullständig lista över allt du måste konfigurera för din Data API Builder-lösning.

Namnge entiteter med hjälp av Pascal-hölje

När du lägger till en entitet i konfigurationsfilen använder du PascalCasing, så att de genererade GraphQL-typerna blir lättare att läsa. Om du till exempel har en entitet med namnet CompositeNameEntity det genererade GraphQL-schemat har följande frågor och mutationer:

• Frågor

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutationer

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Om entiteten mappar till en lagrad procedur får den genererade frågan eller mutationen namnet executeCompositeNameEntity, vilket är enklare och trevligare att läsa.

Använd singularform när du namnger entiteter

När du lägger till en entitet i konfigurationsfilen måste du använda det unika formuläret för namnet. Data API Builder genererar automatiskt pluralformen när en samling av den entiteten returneras. Du kan också ange singular- och pluralformulär manuellt genom att lägga till dem i konfigurationsfilen manuellt. Mer information finns i GraphQL-konfigurationsreferens.

Nästa steg