Aanbevolen procedures voor configuratie in Data API Builder

Diagram van de volgorde van de implementatiehandleiding, inclusief deze locaties, in volgorde: Overzicht, Plannen, Voorbereiden, Publiceren, Bewaken en Optimalisatie. De locatie Optimaliseren is momenteel gemarkeerd.

Dit artikel bevat de huidige aanbevolen procedures voor configuratie in de Data API Builder. Dit artikel bevat geen volledige lijst met alles wat u moet configureren voor uw Data API Builder-oplossing.

Entiteiten benoemen met PascalCasing

Wanneer u een entiteit toevoegt aan het configuratiebestand, gebruikt u PascalCasing, zodat de gegenereerde GraphQL-typen gemakkelijker te lezen zijn. Als u bijvoorbeeld een entiteit hebt met de naam CompositeNameEntity, bevat het gegenereerde GraphQL-schema de volgende query's en mutaties:

• Opvragen

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutaties

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Als de entiteit wordt toegewezen aan een opgeslagen procedure, wordt de gegenereerde query of mutatie genoemd executeCompositeNameEntity, wat gemakkelijker en mooier is om te lezen.

Enkelvoudig formulier gebruiken bij het benoemen van entiteiten

Wanneer u een entiteit aan het configuratiebestand toevoegt, moet u het enkelvoudige formulier voor de naam gebruiken. Data API Builder genereert automatisch het meervoudformulier wanneer een verzameling van die entiteit wordt geretourneerd. U kunt ook handmatig enkelvoudige en meervoudformulieren opgeven door ze handmatig toe te voegen aan het configuratiebestand. Zie De GraphQL-configuratiereferentie voor meer informatie.

Volgende stap

Aanbevolen beveiligingsprocedures