Wenex Platform — Developer Documentation

Version: 1.6.0 | Node: 22.x | Package Manager: pnpm 10.5.2

Wenex Platform is a large-scale distributed microservices system built with NestJS. It exposes a unified REST, GraphQL, and MCP (Model Context Protocol) gateway in front of 15 domain microservices backed by MongoDB, PostgreSQL, Redis, Kafka, Elasticsearch, and MQTT.

---

Table of Contents

Document	Description
Getting Started	Clone, install, seed, and run the platform
Ecosystem & ABAC Model	How Clients, Coworkers, and the Platform relate — read this first
Architecture	System design, request flow, data layer, Mermaid diagrams
API Reference
Authentication	Tokens, APTs, scopes, RBAC — with curl examples
REST Reference	All REST endpoints, headers, responses, curl examples
GraphQL Reference	All queries and mutations with examples
Filtering & Pagination	query, populate, projection, pagination, zone
Streaming (SSE)	Cursor / Server-Sent Events endpoint
SDK
SDK Guide	@wenex/sdk installation, configuration, and examples
Services
Service Catalog	All 15 microservices — purpose, ports, collections
MCP
MCP Integration	MCP tools, AI agent usage, mcp-client.ts
Client Development
Client Development Guide	Building a client app — canonical structure, patterns, best practices

---

Quick Reference

Gateway Endpoints

Path	Purpose
http://localhost:3010/api	Swagger UI (OpenAPI)
http://localhost:3010/api-json	OpenAPI JSON spec
http://localhost:3010/graphql	Apollo GraphQL Playground
http://localhost:3010/mcp	MCP streamable HTTP transport
http://localhost:3010/metrics	Prometheus metrics
http://localhost:3010/status	Liveness / readiness health check

URL Pattern

Every REST endpoint follows:

/{service}/{collection}/{operation}

Examples:

GET  /identity/users
POST /financial/accounts
GET  /auth/apts/count

Request Headers

Header	Type	Purpose
Authorization	Bearer <jwt>	Required for all protected routes
x-request-id	string	Trace ID (auto-generated if omitted)

---

C4 Diagrams

Architecture diagrams live in diagrams/ (at project root):

• Context Diagram — system-level actors
• Container Diagram — platform internals
• Client Container Diagram — client-side view
• Request Flow — end-to-end request path