GraphQL.cz/Fórum/Jak se správně pojmenovávají pole a typy ve schématu GraphQL?

Jak se správně pojmenovávají pole a typy ve schématu GraphQL?

Jsem docela nováček v GraphQL a tak nějak se mi pletou pojmy, když se snažím pochopit, jak správně pojmenovávat pole a typy ve svých schématech. Mám pocit, že by to mělo mít nějakou logiku, ale zatím jsem si nevytvořil žádný systém, který by mi v tom pomohl. Když se podívám na příklady z různých projektů, tak vidím různé přístupy, ať už jde o používání camelCase nebo snake_case, což mi dodává ještě více zmatek. Například, když mám objekt typu User, jak bych měl správně pojmenovat pole jako je jméno a příjmení? Mělo by to být 'firstName' a 'lastName' nebo 'first_name' a 'last_name'? A co se týče samotného názvu typu, je lepší používat jednotné číslo nebo množné číslo? Viděl jsem obojí ve vzorcích a nevím, co z toho je doporučené. Navíc bych chtěl vědět, jestli existují nějaké best practices pro pojmenovávání polí, které by mi pomohly udržet konzistenci a srozumitelnost v celém API. Jaké jsou vaše zkušenosti s tímto tématem? Měli byste nějaké tipy nebo rady, jak na to? Děkuju.

168 slov
1.7 minut čtení
6. 8. 2024
Michaela Zichová

Pojmenovávání v GraphQL fakt může být matoucí. Co se týče typů, většinou se doporučuje používat jednotné číslo, takže místo 'Users' bys měl mít 'User'. U polí je populární používat camelCase, takže by to bylo 'firstName' a 'lastName'. Snake_case jako 'first_name' se moc nepoužívá, aspoň ne v GraphQL. Důležitý je udržet konzistenci, jestli se rozhodneš pro camelCase, tak to dodržuj všude. Mnoho lidí taky doporučuje, aby názvy polí byly srozumitelné a popisné, jako třeba 'createdAt' nebo 'userEmail'. Když se ti to pak dostane do rukou, tak budeš mít lepší přehled a nebudeš muset listovat dokumentací. Drž se toho, co ti přijde nejlogičtější a hlavně si to pojmenování jednou nastav a neměň to. To ti pomůže mít v tom jasno.

118 slov
1.2 minut čtení
16. 11. 2024
David Duchoň

Pojmenovávání v GraphQL může být fakt zmatený, ale mám pár tipů. Obecně se doporučuje používat camelCase pro názvy polí. Takže místo 'first_name' bych šel do 'firstName' a 'lastName'. Pro typy je dobrý držet se jednotného čísla, takže místo 'Users' mluv o 'User'. To dává smysl, protože každý typ reprezentuje jeden objekt.

Co se týče konzistence, snaž se dodržovat stejnej styl v celým API. Jestli začneš s camelCase, tak to dodržuj všude. Když máš složitější objekty, tak jména polí by měla být jasně popisná, aby bylo hned jasný, co dělají. Například místo 'data' používej něco jako 'userData'. Takže jo, prostě si stanov pravidla a drž se jich. Uvidíš, že to pak bude mnohem snazší.

113 slov
1.1 minut čtení
8. 1. 2025
Věra Jandová

K pojmenovávání v GraphQL je pár dost jasnejch praktik. Obecně se doporučuje používat camelCase, takže pro pole v User typu bys měl mít 'firstName' a 'lastName', ne 'first_name'. U typů je spíš zvykem používat jednotné číslo, takže místo Users bys měl mít User. To dává smysl, když pak dotazuješ konkrétního uživatele. Co se týká konzistence, drž se jednoho stylu napříč celým API, to hodně pomůže. Dobré je taky vyhnout se zkrátkám a nejasným názvům, aby bylo jasný, co vlastně pole znamená. Takže radši 'email' než 'e', chápeš? Takhle se to dá líp číst a pochopit, což je vždycky plus.

99 slov
1 minut čtení
23. 8. 2024
Adam Dobeš
GraphQL.cz/Články/Schema design
Jak správně pojmenovávat typy a pole ve vašem GraphQL schématuTento článek se zaměřuje na důležitost standardizace pojmenování v GraphQL schématech. Představíme si tipy a triky, jak zajistit jednoznačnost a srozu...
1000 slov
10 minut čtení
28. 4. 2024
Markéta Svobodová
Přečíst článek
Podobné otázky