Práticas recomendadas de configuração no Construtor de API de Dados

Este artigo inclui as práticas recomendadas atuais para configuração no construtor de API de Dados. Este artigo não inclui uma lista completa de tudo o que você deve configurar para sua solução do Construtor de API de Dados.

Nomear entidades usando caixa Pascal

Ao adicionar uma entidade ao arquivo de configuração, use PascalCasing para que os tipos de GraphQL gerados sejam mais fáceis de ler. Por exemplo, se você tiver uma entidade chamada CompositeNameEntity, o esquema GraphQL gerado terá as seguintes consultas e mutações:

• Perguntas

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutações

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Se a entidade for mapeada para um procedimento armazenado, a consulta ou mutação gerada será nomeada executeCompositeNameEntity, o que é mais fácil e agradável de ler.

Usar formulário singular ao nomear entidades

Ao adicionar uma entidade ao arquivo de configuração, use o formulário singular para o nome. O Construtor de API de Dados gera automaticamente o formulário plural sempre que uma coleção dessa entidade é retornada. Você também pode fornecer manualmente formulários singulares e plural, adicionando-os manualmente ao arquivo de configuração. Para obter mais informações, consulte a referência de configuração do GraphQL.

Próxima etapa