Skip to content

Server Routes in Dev

This page lists the routes available while developing locally and clarifies which ones are provided by atomo dev versus atomo dev --workspace.

Common (both modes)

  • /health — health check
  • /ready — readiness probe; checks DB connectivity
  • /version — build/version info: { name, version, commit, buildTime }. Values are baked into the published image at build time (ATOMO_VERSION/ATOMO_GIT_SHA/ ATOMO_BUILD_TIME); a plain cargo run reports the crate version + unknown. Use it to confirm which build is deployed.
  • /graphql — GraphQL endpoint (POST for operations)
  • GraphQL IDE
    • atomo dev: GET /graphql serves the playground
    • atomo dev --workspace: GET /playground serves GraphiQL
  • /schema.ts — raw schema file served in development (used by Admin UI/tooling)

atomo dev (full platform server)

  • / — root info
  • /info — server info
  • /graphql — GET (playground), POST (operations)
  • /meta/schema — JSON metadata of models (optional auth)
  • Auth (REST)
    • POST /auth/login
    • POST /auth/logout
    • GET /auth/me
  • Audit (REST)
    • GET /audit/logs
    • GET /audit/user/:user_id/activity
    • GET /audit/entity/:entity_type/:entity_id/audit
    • GET /audit/statistics

workspace mode (service‑scoped hot reload server)

  • / — service health message (Workspace Dev)
  • /health — health check
  • /graphql — POST (operations)
  • /playground — GraphiQL IDE
  • /schema.ts — raw TS schema (multiple path fallbacks)
  • Admin UI proxy (requires packages/atomo-admin-ui dev server on :5173)
    • /admin → 301 to /admin/
    • /admin/ → proxies to http://localhost:5173/
    • /admin/* → proxies to http://localhost:5173/*
  • Vite asset proxies (workspace mode only)
    • /@vite/*, /@react-refresh
    • /@fs/*, /src/*, /node_modules/*

Observability

  • /metrics — Prometheus metrics in text exposition format (both modes)

Ports

  • Service/API default: http://localhost:3000
  • Admin UI dev server: http://localhost:5173 (proxied under /admin in workspace mode)

Notes

  • Admin proxy returns a helpful message if the UI dev server is not running.
  • CORS: workspace‑dev enables permissive CORS for easier local development.

Released under the AGPL-3.0 License.