Skip to content

API.md

Latest commit

 

History

History
78 lines (54 loc) · 2.09 KB

API.md

File metadata and controls

78 lines (54 loc) · 2.09 KB
Raw

API Guide

Back to main README

Base URLs

  • Local API root: http://localhost:4000/api
  • Uploads are served from: http://localhost:4000/uploads/...

Health

  • GET /api/health

Auth

  • POST /api/auth/login
  • GET /api/auth/me

All /api/* routes except /api/health and /api/auth/login require a bearer token.

Modules

  • GET /api/modules

Templates

  • GET /api/templates
  • GET /api/templates?moduleId=lesson-planner
  • POST /api/templates
  • PUT /api/templates/:id
  • DELETE /api/templates/:id

Schedule Organizer

  • GET /api/modules/schedule-organizer
  • POST /api/modules/schedule-organizer
  • PUT /api/modules/schedule-organizer/:id
  • DELETE /api/modules/schedule-organizer/:id

Reminder Center

  • GET /api/modules/reminder-center
  • POST /api/modules/reminder-center
  • PUT /api/modules/reminder-center/:id
  • DELETE /api/modules/reminder-center/:id
  • POST /api/modules/reminder-center/:id/complete

Lesson Planner

  • GET /api/modules/lesson-planner
  • POST /api/modules/lesson-planner
  • PUT /api/modules/lesson-planner/:id
  • DELETE /api/modules/lesson-planner/:id
  • POST /api/modules/lesson-planner/:id/generate-worksheet-draft

Worksheet Designer

  • GET /api/modules/worksheet-designer
  • POST /api/modules/worksheet-designer
  • PUT /api/modules/worksheet-designer/:id
  • DELETE /api/modules/worksheet-designer/:id
  • GET /api/modules/worksheet-designer/:id/export/spec
  • GET /api/modules/worksheet-designer/:id/export/preview
  • GET /api/modules/worksheet-designer/:id/export/docx
  • GET /api/modules/worksheet-designer/:id/export/pdf

Resource Vault

  • GET /api/modules/resource-vault
  • POST /api/modules/resource-vault/upload
  • PUT /api/modules/resource-vault/:id
  • DELETE /api/modules/resource-vault/:id

Notes

  • The current API is designed for local/demo use.
  • Response shapes remain intentionally simple, mostly { items }, individual item payloads, or { success, item }.
  • The current test suite covers auth, CRUD behavior, migration/bootstrap, worksheet generation, reminder recurrence, and resource cleanup.