GraphQL.cz/Fórum/Jak mám pojmenovat pole pro email v GraphQL?

Jak mám pojmenovat pole pro email v GraphQL?

Přemýšlím, jak bych měl pojmenovat pole pro email ve svém GraphQL schématu. Mám na mysli, že je důležité, aby to bylo jasné a výstižné, ale zároveň chci, aby to odpovídalo konvencím, které se používají v GraphQL. Rozhoduji se mezi různými názvy, jako například 'email', 'emailAddress' nebo 'userEmail'. Zajímalo by mě, co si o tom myslíte vy, kteří máte s GraphQL více zkušeností. Vím, že názvy by měly být popisné a snadno pochopitelné pro každého, kdo s API pracuje, ale také bych rád věděl, jestli jsou nějaké best practices nebo doporučení týkající se pojmenování polí v GraphQL. Měl bych se držet nějakých konkrétních pravidel? Jaké názvy používáte ve svých projektech? Myslíte si, že by měl být název pole třeba delší nebo naopak kratší? Zkoušel jsem také hledat příklady v dokumentaci a různých open-source projektech, ale narazil jsem na různé styly a přístupy. Rád bych slyšel vaše názory a případně se i inspiroval vašimi zkušenostmi. Jak to vidíte? Jaký název byste zvolili a proč?

162 slov
1.6 minut čtení
7. 12. 2024
Zuzana Havlíčková
Zuzana Havlíčková

Tak já bych šel asi s tím nejjednodušším - prostě 'email'. Většina lidí ví, co to znamená a navíc to je krátký a jasný. Když začneš přidávat další slova jako 'emailAddress' nebo 'userEmail', tak to může být zbytečně komplikovaný. V GraphQL je dobrý držet se jednoduchosti, aby to bylo přehledný. Samozřejmě, pokud máš v projektu víc typů uživatelů, tak by možná bylo fajn mít něco jako 'adminEmail' nebo 'customerEmail', ale jinak bych to neřešil. Vždycky je dobrý mít konzistenci, takže když už zvolíš nějaký styl pojmenování, tak se ho držuj v celým schématu. Hlavně, ať ti to dává smysl a bude to srozumitelný pro ostatní, co s tím budou pracovat.

110 slov
1.1 minut čtení
30. 1. 2025
Ladislav Matoušek
Ladislav Matoušek

Když se rozhoduješ, jak pojmenovat pole pro email v GraphQL, tak bych šel buď po jednoduchosti, nebo po jasnosti. Mně se líbí "email". Je to krátký a jasný název, všichni ví, co to znamená. "emailAddress" je taky v pohodě, ale už je to trochu delší a možná zbytečně složitý. "userEmail" bys měl použít jenom pokud máš víc různých emailů a chceš to rozlišovat.

Obecně platí, že názvy by měly být intuitivní a snadno pochopitelné. Takže drž se jednoho slova pokud to jde. Většina lidí v komunitě to má takhle, takže když někdo uvidí "email", bude hned vědět, o co jde. Snaž se vyhnout zbytečným zkráceninám nebo technickým termínům, který nikdo nezná. Jo a klidně se podívej na nějaké open-source projekty a inspiruj se tím, co tam používají. Takhle se můžeš dostat k dobrému názvu bez toho, abys musel vymýšlet kolo.

140 slov
1.4 minut čtení
28. 1. 2025
Elena Vávrová
Elena Vávrová

Tak já bych to viděl tak, že nejlepší název pro pole s emailem je prostě 'email'. Je to krátké a jasné. Když pak někdo kouká na API, hnedka pochopí, co to je. Jako alternativy jsou i 'emailAddress' nebo 'userEmail', ale to mi přijde zbytečně dlouhé. V GraphQL se obecně snažím držet co nejjednodušších a nejvýstižnějších názvů. Zbytečně dlouhý název může být matoucí a navíc to zvyšuje šanci, že uděláš chybu při psaní. Taky se vyplatí kouknout na další projekty, ale většinou tam najdeš tyhle varianty. Takže za mě jednoznačně 'email', ideálně žádný zbytečný prefix, prostě přímo k věci.

98 slov
1 minut čtení
8. 2. 2025
Marek Matoušek
Marek Matoušek
Podobné otázky