Najlepsze rozwiązania dotyczące konfiguracji w narzędziu Data API Builder

Diagram sekwencji przewodnika wdrażania, w tym tych lokalizacji, w kolejności: Przegląd, Planowanie, Przygotowywanie, Publikowanie, Monitorowanie i Optymalizacja. Lokalizacja "Optymalizuj" jest obecnie wyróżniona.

Ten artykuł zawiera bieżące zalecane najlepsze rozwiązania dotyczące konfiguracji w konstruktorze interfejsu API danych. Ten artykuł nie zawiera wyczerpującej listy wszystkich elementów, które należy skonfigurować dla rozwiązania konstruktora interfejsu API danych.

Nazwij jednostki stosując notację Pascal

Podczas dodawania jednostki do pliku konfiguracji użyj PascalCasing, aby wygenerowane typy GraphQL były łatwiejsze do odczytania. Na przykład jeśli masz jednostkę o nazwie CompositeNameEntity wygenerowany schemat GraphQL ma następujące zapytania i mutacje:

• Queries

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutacje

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Jeśli jednostka jest mapowana na procedurę składowaną, wygenerowane zapytanie lub mutacja będą mieć nazwę executeCompositeNameEntity, co jest łatwiejsze i przyjemniejsze do odczytania.

Używaj formy pojedynczej podczas nazewnictwa encji

Podczas dodawania elementu do pliku konfiguracji pamiętaj, aby użyć nazwy w liczbie pojedynczej. Mechanizm tworzenia API danych automatycznie generuje formę mnogą za każdym razem, gdy zwracana jest kolekcja tej jednostki. Można również ręcznie podać formy pojedyncze i mnogie, dodając je do pliku konfiguracyjnego. Aby uzyskać więcej informacji, zobacz GraphQL configuration reference (Dokumentacja konfiguracji języka GraphQL).

Następny krok

najlepsze rozwiązania dotyczące zabezpieczeń