Meilleures pratiques de configuration dans le générateur d’API de données

Diagramme de la séquence du guide de déploiement, y compris ces emplacements, dans l’ordre : Vue d’ensemble, Plan, Préparation, Publication, Surveillance et Optimisation. L’emplacement « Optimiser » est actuellement mis en surbrillance.

Cet article inclut les meilleures pratiques recommandées pour la configuration dans le générateur d’API de données. Cet article n’inclut pas de liste exhaustive de tout ce que vous devez configurer pour votre solution de générateur d’API de données.

Nommer des entités à l’aide de la casse Pascal

Lors de l’ajout d’une entité au fichier de configuration, utilisez PascalCasing afin que les types GraphQL générés soient plus faciles à lire. Par exemple, si vous avez une entité nommée CompositeNameEntity le schéma GraphQL généré comporte les requêtes et mutations suivantes :

• Requêtes

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutations

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Si l’entité est mappée à une procédure stockée, la requête ou mutation générée est nommée executeCompositeNameEntity, ce qui est plus facile et plus agréable à lire.

Utiliser un formulaire singulier lors de l’affectation de noms d’entités

Lors de l’ajout d’une entité au fichier de configuration, veillez à utiliser le formulaire singulier pour le nom. Le générateur d’API de données génère automatiquement le formulaire plural chaque fois qu’une collection de cette entité est retournée. Vous pouvez également fournir manuellement des formulaires singuliers et pluriels en les ajoutant manuellement au fichier de configuration. Pour plus d’informations, consultez la référence de configuration GraphQL.

Étape suivante

Bonnes pratiques de sécurité