Documentation Swagger Interactive
Chatbotaurus fournit une documentation API interactive via Swagger UI, generee a partir du fichier OpenAPI swagger.yml.
Lancer Swagger UI
Le serveur Swagger est un projet standalone dans api-documentation/ :
cd api-documentation
pnpm install
pnpm build
pnpm start
Swagger UI est alors accessible sur http://localhost:6655/api-docs.
Contenu de la spec OpenAPI
Le fichier api-documentation/src/yml/swagger.yml documente l'ensemble des endpoints :
| Section | Endpoints | Description |
|---|---|---|
| MCP Streamable HTTP | 3 | Transport JSON-RPC 2.0 (POST/GET/DELETE /mcp) |
| Catalogue public | 1 | Liste des serveurs MCP |
| Catalogue business | 13 | Deploiement one-click, profils, monitoring, securite |
| MCP Gateways | 5 | CRUD workflows conversationnels |
| Messages | 2 | Historique des conversations |
| Prediction | 1 | Envoi de messages IA |
| Warm Start | 1 | Reconnexion intelligente |
| Feedback | 2 | Retours utilisateurs |
| Document Store | 8 | Indexation vectorielle Qdrant |
| Outils | 5 | Outils MCP personnalises |
| Variables | 4 | Configuration |
| Credentials | 4 | Gestion des secrets |
| Stats | 3 | Analytics |
| Compliance | 3 | Conformite EU |
| Health | 5 | Monitoring sante |
Authentification
La plupart des endpoints necessitent un token Bearer obtenu via Keycloak SSO :
Authorization: Bearer <access_token>
Les endpoints publics (catalogue MCP, health) ne necessitent pas d'authentification.
Serveur de developpement
Par defaut, Swagger pointe vers http://localhost:3000/api/v1 (backend en mode developpement).
Pour pointer vers le staging :
https://staging.chatbotaurus.eu/api/v1