Skip to content

Swagger / API Docs

Chaque service expose sa documentation Swagger sur /api-docs en local.

URLs locales

ServiceURL Swagger
authhttp://localhost:3001/api-docs
ledger-walletshttp://localhost:3002/api-docs
customer-profiles-kychttp://localhost:3003/api-docs
orchestratorhttp://localhost:3004/api-docs
notificationshttp://localhost:3005/api-docs
configurationhttp://localhost:3006/api-docs
file-servicehttp://localhost:3007/api-docs
providers-gatewayhttp://localhost:3008/api-docs
risk-enginehttp://localhost:3009/api-docs
service-cataloghttp://localhost:3010/api-docs
logs-reportinghttp://localhost:3011/api-docs

Swagger Hub (mode Docker)

En mode Docker, un Swagger Hub agrege la documentation de tous les services :

http://localhost:28888

Conventions API

  • Les reponses suivent un format standard : { success, data, message, errors }
  • Les erreurs retournent des codes HTTP standards (400, 401, 403, 404, 500)
  • La pagination utilise ?page=1&limit=20
  • Les dates sont en format ISO 8601

NxPay — Plateforme fintech CEMAC