API Endpoints

RESTful API documentation and usage examples.

Base URL

API Base
Development: http://localhost:8000/api/v1
Production:  https://api.yourdomain.com/api/v1

Available Endpoints

MethodEndpointAuthDescription
POST/auth/registerNoRegister new user
POST/auth/loginNoLogin user
GET/users/meYesGet current user
PUT/users/meYesUpdate profile
GET/healthNoHealth check

Authentication

Protected endpoints require a Bearer token in the Authorization header:

cURL Example
curl -X GET "http://localhost:8000/api/v1/users/me" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

OpenAPI Documentation

Interactive API documentation is available at /docs (Swagger UI) and /redoc (ReDoc) when running the development server.