Hugo SaaS BackendAPI Documentation

REST and GraphQL API reference for the Hugo SaaS Backend services.

REST API Reference

Static Redoc-generated reference pages for Identity Service and Entitlement Service REST APIs, browsable without running any services.

GraphQL API Guide

Handwritten Admin BFF and Entitlement Service query examples for the frontend workflows this backend supports.

Database ER Diagram

Mermaid diagrams for the shared SaaS data model, with focused views for organizations, entitlements, imports, and activity logs.

Companion Products

Product	Repository	APIs Used
Hugo SaaS Console	HugoHZXu/hugo-saas-console	Admin BFF, Identity Service, Entitlement Service
Hugo Entitlement Console	HugoHZXu/hugo-entitlement-console	Entitlement GraphQL, Allocation REST, Identity Service
Hugo Entitlement Importer Desktop	HugoHZXu/hugo-entitlement-importer-desktop	Entitlement Bulk Import REST

Local Service Endpoints

When running services locally, each exposes a Swagger UI and GraphiQL explorer for interactive testing (toggle with ENABLE_INTERNAL_DOCS). The table below lists the default local URLs for reference when setting up a frontend project:

Service	URL
Admin BFF	`http://127.0.0.1:4010`
Entitlement Service	`http://127.0.0.1:4317`
Identity Service	`http://127.0.0.1:4320`