Pavewise - Style Guide & More
  • At a Glance
    • Tech Stack
  • Frontend
    • Overview
    • Config & Tooling
      • Editor / IDE setup
        • General
        • Snippets
        • Formatting
          • "Format on save"
          • Prettier (.prettierrc)
        • Linting
          • ESLint (.eslintrc.json)
        • TS Config (tsconfig.json)
      • Browser setup
      • Command Line setup
        • Aliasing (.zshrc, etc.)
    • Workflow
    • Basic Guidelines
      • JavaScript
      • React
      • TypeScript
    • Naming
      • Extensions
      • Folders/Directories
      • Filenames
      • Declarations
    • Our Systems
      • Overview
      • Pages
        • File-based routing
        • "Route" folder
      • Components
        • Overview
        • MUI
          • General
          • Styling choices
          • Choosing Components
        • StorybookJS
      • State Management
        • General State Strategy
        • Client Global State
        • Server Global State
        • URL state
      • Data Fetching & APIs
        • "api" object
        • "Router" folder
      • Forms
      • Charts
      • Tables
    • Additional
      • Styling
      • Helpful websites/tools
    • // TODO
      • Component Architecture
      • Component Structure
      • Creating a New Component...
    • 🥳 Onboarding
    • 👩‍🏫 Learning Resources
      • ReactJS
        • Function Declarations vs Function Expressions
      • TypeScript
      • (Global) State Management
      • Charting Libraries (JS)
      • (Not Implemented)
        • StorybookJS
        • NextJS
  • API
    • Overview
    • Introduction
    • Versioning
    • Authentication
    • HTTP Methods
    • Endpoints
    • Query Params
    • Request & Response Format
    • Error Handling
    • Status Codes
    • Database Relationship Types
    • Additional Topics
      • Rate Limiting
    • 💻 Examples
    • 👩‍🏫 Learning Resources
  • Backend
    • Overview
    • Workflow
    • Topics
    • File Setups
      • Routes (routes.rb)
      • Schema (schema.rb)
      • Models (models/x.rb)
      • Controllers (x_controller.rb)
        • Database Relationships
        • Controller Actions
          • :index
          • :show
          • :create
          • :update
          • :destroy
        • Controller Concerns
          • :index
            • QueryParamsProcessor
          • :show (none)
          • :create (none)
          • :update (none)
          • :destroy (none)
        • Controller [X]
          • :index (none)
          • :show (none)
          • :create (none)
          • :update (none)
          • :destroy (none)
        • Controller [Y]
          • :index (none)
          • :show (none)
          • :create (none)
          • :update (none)
          • :destroy (none)
        • Other Information
          • Multi-table Data Retrieval via Single Frontend Request
    • Database Tables
      • Roles / Permissions
    • Ruby gems
    • AI
    • 👩‍🏫 Learning Resources
      • Ruby on Rails (Rails)
  • Database
    • Overview
    • 👩‍🏫 Learning Resources
  • Dev Ops
    • Overview
    • 👩‍🏫 Learning Resources
Powered by GitBook
On this page
  1. API

Endpoints

Explanation of resource naming conventions, path structures, etc.

PreviousHTTP MethodsNextQuery Params

Last updated 1 year ago

  • 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.) ()

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

see BACKEND style guide