Skip to content

README.md

Latest commit

 

History

History
75 lines (53 loc) · 2.23 KB

README.md

File metadata and controls

75 lines (53 loc) · 2.23 KB
Raw

Coral Examples

These examples are intentionally simple and focused on Coral's core routing features. Each file is self-contained and ready to run after installing dependencies.

Prerequisites

  • Node.js 20+
  • MongoDB running locally, or set MONGO_URI

Install dependencies

npm install express mongoose coral

Run an example

node examples/basic-crud.js

Example Set

  1. basic-crud.js
  • Baseline CRUD resource using schema validation and indexes.
  • Covers: path, model, perPage, bodyFilter.
  1. methods-and-middlewares.js
  • Restrict methods and run middleware before Coral handlers.
  • Covers: methods, middlewares, fields, bodyFilter.
  1. custom-id-attribute-and-param.js
  • Route by business key from URL params instead of _id.
  • Covers: idAttribute, idParam, methods, middlewares.
  1. query-defaults-and-overrides.js
  • Apply default filters/options/projections with safe runtime overrides.
  • Covers: conditions, options, fields, query, perPage.
  1. pagination-and-limit-control.js
  • Demonstrates page-based pagination and limit capping behavior.
  • Covers: perPage, query runtime behavior.
  1. body-filter.js
  • Whitelist request body keys to prevent mass assignment.
  • Covers: bodyFilter, methods.
  1. update-ref.js
  • Update parent references during create operations.
  • Covers: updateRef.
  1. subdoc-single-level.js
  • CRUD operations for embedded arrays under a parent document.
  • Covers: subDoc, top-level idAttribute, top-level idParam.
  1. subdoc-multi-level.js
  • Nested subDoc configuration for multi-level embedded routing.
  • Covers: recursive subDoc.subDoc, mixed idParam + idAttribute.

Query Params Supported by Coral

For list routes (GET <path>):

  • skip
  • limit
  • page
  • sort
  • order (asc, desc, 1, -1)
  • select (comma-separated list)

Environment Variables

  • MONGO_URI (optional, defaults to local MongoDB)
  • INTERNAL_API_KEY (used by methods-and-middlewares.js)