Skip to content

Backend: API Design Guidelines

Brian Tkatch edited this page Oct 3, 2025 · 3 revisions

Naming endpoints and fields

  • Avoid redundant words, brand names, or trademarks
  • Avoid acronyms unless they are universally understood (like ID)
  • Use the plural form for endpoints that can return more than one resource (like /stations)
  • Use the single form for endpoints that return details about one resource (like /stations/1)
  • Use lowerCamelCase for all endpoints and JSON property names.
  • Acronyms should be cased like normal words, not all uppercase (like id or userId, not ID or userID)

Clone this wiki locally