Skip to content

Services Documentation

Complete documentation for all microservices in the Portugal Odyssey platform.

Service Overview

Service Description Tech Stack Documentation
api-gateway Entry point for REST requests TypeScript, Express api-gateway/
auth-service Authentication & authorization NestJS, Keycloak auth-service/
user-management User profile management NestJS user-management/
experience-service Experience catalog API TypeScript, Express experience-service/
payment-service Stripe integration NestJS payment-service/
notification-service Notifications hub NestJS, RabbitMQ notification-service/
file-service File management NestJS file-service/
partner-service Partner & Service management NestJS partner-service/
~~rag-service~~ Folded into ai-service in W2-7 (2026-04-30). — —
ai-service AI tools + RAG pipeline + single platform MCP surface Python, FastAPI, LangChain, pgvector ai-service/
review-service Reviews & ratings NestJS, Postgres review-service/
strapi-cms Content management Strapi v5 strapi-cms/

Service Documentation Structure

Each service has its own directory with:

  • README.md - Service overview, endpoints, configuration
  • development.md - Local development setup
  • api-reference.md - Complete API documentation
  • integration.md - Integration guides

Core Services

  • API Gateway - Request routing
  • Auth Service - Authentication
  • User Management - User profiles

Business Services

Supporting Services

  • Notification Service - Notifications
  • File Service - File storage
  • AI Service - AI tools + RAG pipeline + platform MCP surface (rag-service folded in W2-7)
  • Review Service - Reviews

Content Management

  • Strapi CMS - Content management

Service Communication

Synchronous (REST/GraphQL)

  • Direct HTTP calls between services
  • Via API Gateway for external access

Asynchronous (RabbitMQ)

  • Event-driven communication
  • Decoupled service interactions

Development

Running Services Locally

cd services/[service-name]
npm install
npm run dev

Service-Specific Documentation

Each service directory contains: - Setup instructions - API documentation - Integration examples - Troubleshooting guides

See Also