Endpoints

Explanation of resource naming conventions, path structures, etc.

  • Use plural nouns (e.g., /contacts, /team-members).

  • Use hyphens to separate words in URLs (e.g., /quality-goals).

  • Nest related resources when appropriate (/authors/1/books/2)

    • Most resources will be a "top-level" resource (not nested)

    • We use nesting in the backend (via routes.rb file) for relationships (many-to-many, one-to-many, etc.) (see BACKEND style guide)

    • UPDATE (10/2/23): We may be moving away from nesting for these relationships per Jase's new suggestion

PreviousHTTP MethodsNextQuery Params

Last updated