Skip to main content

Backend API Reference Guide

The backend TypeScript API reference is generated from source annotations and signatures.

Entry Point​

How To Navigate​

  • application/**: domain services and repository contracts.
  • core/**: workflows, payments, auth routes, email, notifications.
  • infrastructure/**: Prisma implementations and unit-of-work.
  • data/schema and data/permissions: GraphQL root and permission layer.

Regeneration​

Run:

yarn workspace @adamondo/backend generate:docs:api

or as part of full backend docs:

yarn workspace @adamondo/backend generate:docs

Annotation Style​

Use TSDoc blocks on exported classes/functions/types:

/**
 * Short summary.
 *
 * @param value Description.
 * @returns Description.
 */

This improves generated docs quality and search relevance.