Skip to content

User API

Jump to bottom
Tomas Sirio edited this page Oct 16, 2025 · 1 revision

User API

The User API provides endpoints for creating and querying user information.

Command Operations (Port 8081)

Base URL: http://localhost:8081/api/1/users

Create User

Create a new user in the system.

Endpoint: POST /api/1/users

Authentication: Not required (public endpoint)

Request Body

{
  "username": "string"
}
Field Type Required Description
username string Yes Unique username

Response

Status: 201 Created

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "username": "johndoe"
}

Example

curl -X POST http://localhost:8081/api/1/users \
  -H "Content-Type: application/json" \
  -d '{
    "username": "johndoe"
  }'

Query Operations (Port 8082)

Base URL: http://localhost:8082/api/1/users

Get User by ID

Retrieve a specific user by their UUID.

Endpoint: GET /api/1/users/{id}

Authentication: Required (USER or ADMIN role)

Path Parameters

Parameter Type Description
id UUID User's unique identifier

Response

Status: 200 OK

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "username": "johndoe"
}

Example

curl -X GET http://localhost:8082/api/1/users/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer <your-token>"

Get User by Username

Retrieve a user by their username.

Endpoint: GET /api/1/users/username/{username}

Authentication: Not required (public endpoint)

Path Parameters

Parameter Type Description
username string User's username

Response

Status: 200 OK

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "username": "johndoe"
}

Example

curl -X GET http://localhost:8082/api/1/users/username/johndoe

Get Current User

Retrieve the profile of the currently authenticated user.

Endpoint: GET /api/1/users/me

Authentication: Required (USER or ADMIN role)

Response

Status: 200 OK

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "username": "johndoe"
}

Example

curl -X GET http://localhost:8082/api/1/users/me \
  -H "Authorization: Bearer <your-token>"

Error Responses

404 Not Found

User doesn't exist:

{
  "timestamp": "2025-10-16T10:30:00.000Z",
  "status": 404,
  "error": "Not Found",
  "message": "User not found with id: 550e8400-e29b-41d4-a716-446655440000",
  "path": "/api/1/users/550e8400-e29b-41d4-a716-446655440000"
}

401 Unauthorized

Missing or invalid authentication token:

{
  "timestamp": "2025-10-16T10:30:00.000Z",
  "status": 401,
  "error": "Unauthorized",
  "message": "Full authentication is required to access this resource",
  "path": "/api/1/users/550e8400-e29b-41d4-a716-446655440000"
}

Usage Examples

Complete User Workflow

# 1. Register a new user (creates user and returns token)
RESPONSE=$(curl -X POST http://localhost:8083/api/1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"username":"johndoe","password":"secret123"}')

# Extract token
TOKEN=$(echo $RESPONSE | jq -r '.token')

# 2. Get your own profile
curl -X GET http://localhost:8082/api/1/users/me \
  -H "Authorization: Bearer $TOKEN"

# 3. Look up another user by username
curl -X GET http://localhost:8082/api/1/users/username/janedoe

Next Steps

Trip Tracker Backend API Documentation

Welcome to the Trip Tracker Backend API documentation! This wiki provides comprehensive information about all available REST APIs in the system.

📚 Quick Navigation

Getting Started

API References

Reference Guides

🏗️ Architecture Overview

The Trip Tracker Backend follows a CQRS (Command Query Responsibility Segregation) architecture with three main services:

Service Port Purpose Base Path
tracker-auth 8083 Authentication & user registration /api/1/auth
tracker-command 8081 Write operations (Create, Update, Delete) /api/1
tracker-query 8082 Read operations (Queries) /api/1

🔐 Authentication

All API endpoints (except registration and login) require JWT authentication. Include the token in the Authorization header:

Authorization: Bearer <your-jwt-token>

Get your token by calling the Login endpoint.

🚀 Quick Example

Here's a quick example to get you started:

# 1. Register a new user
curl -X POST http://localhost:8083/api/1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"username":"john","password":"secret123"}'

# 2. Use the returned token to create a trip
curl -X POST http://localhost:8081/api/1/trips \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{"name":"My Camino","visibility":"PUBLIC"}'

# 3. Query your trips
curl -X GET http://localhost:8082/api/1/trips/me \
  -H "Authorization: Bearer <your-token>"

📖 API Documentation

For interactive API documentation with try-it-out functionality, access the Swagger UI:

🤝 Support

For issues, questions, or contributions:

Ready to get started? Check out the Getting Started Guide!

Clone this wiki locally