Chapter 07: Naming

Od vydání první verze mého průvodce designem uplynulo už několik let a vždy jsem měl pocit, že v něm něco ještě chybí. Něco, co ovlivňuje všechny ostatní kapitoly. Když jsem analyzoval nejčastější problémy v API, která navrhovali analytici a mnou proškolení vývojáři, postupně se ukázalo jedno klíčové téma: kvalitní pojmenování. Správný naming totiž zásadně ovlivňuje celé rozhraní, od samotné struktury URL, přes parametry až po návrh obsahu.

  • přesnost: Settings, UserSettings, UserPreferedSettings
  • stálost: ExternalId vs SpotifyId
  • závaznost: JpegUrl vs ImageUrl, HexColor vs Color
  • formát: PublishedDate vs Published (??)

Vše o jmenných konvencích