api-documentation.md

TipTune Backend API Documentation

This is the normalized repository path for backend API documentation.

Primary references

• Interactive Swagger UI: http://localhost:3001/api/docs
• Base path: /api/v1/* except health probes and /api/version
• Service overview: README.md

Coverage

• Authentication and JWT flows
• User and artist profile endpoints
• Track upload and streaming routes
• Search and autocomplete endpoints
• Tip history and transaction status
• WebSocket event surface

Navigation

• Use README.md for local setup and runtime notes.
• Use TESTING.md for backend validation commands.
• Use ../docs/README.md for the repo-wide documentation map.

Note on naming

The legacy file name api -documentation.md is kept as a compatibility redirect so existing bookmarks do not break.