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 oznaczona jako "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.

Nazywaj byty przy użyciu notacji Pascal

Podczas dodawania encji 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 ma nazwę executeCompositeNameEntity, co jest łatwiejsze i przyjemniejsze do odczytania.

Używaj liczby pojedynczej przy nazywaniu encji

Podczas dodawania jednostki do pliku konfiguracji pamiętaj, aby użyć liczby pojedynczej dla nazwy. Konstruktor interfejsu API danych automatycznie generuje formularz w liczbie mnogiej za każdym razem, gdy zostanie zwrócona kolekcja tej jednostki. Można również ręcznie podać formy pojedyncze i mnogie, dodając je do pliku konfiguracji. Aby uzyskać więcej informacji, zobacz GraphQL configuration reference (Dokumentacja konfiguracji języka GraphQL).

Następne kroki

Najlepsze rozwiązania dotyczące zabezpieczeń