Boas práticas de configuração no Data API builder

Este artigo inclui as melhores práticas recomendadas atualmente para configuração no Data API builder. Este artigo não inclui uma lista exaustiva de tudo o que deve configurar para a sua solução de construtor de API de dados.

Nomear entidades usando PascalCase

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

• Consultas

  • compositeNameEntities
  • compositeNameEntity_by_pk

• Mutações

  • createCompositeNameEntity
  • updateCompositeNameEntity
  • deleteCompositeNameEntity

• Se a entidade corresponder a um procedimento armazenado, a consulta ou mutação gerada será chamada executeCompositeNameEntity, tornando-se mais fácil e mais agradável de ler.

Use a forma singular ao nomear entidades

Ao adicionar uma entidade ao ficheiro de configuração, certifique-se de usar a forma singular para o nome. O Data API builder gera automaticamente a forma plural sempre que uma coleção dessa entidade é devolvida. Também pode fornecer manualmente as formas singulares e plurais, adicionando-as manualmente ao ficheiro de configuração. Para mais informações, consulte a referência de configuração GraphQL.

Próximo passo