Aller au contenu principal

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 :

SectionEndpointsDescription
MCP Streamable HTTP3Transport JSON-RPC 2.0 (POST/GET/DELETE /mcp)
Catalogue public1Liste des serveurs MCP
Catalogue business13Deploiement one-click, profils, monitoring, securite
MCP Gateways5CRUD workflows conversationnels
Messages2Historique des conversations
Prediction1Envoi de messages IA
Warm Start1Reconnexion intelligente
Feedback2Retours utilisateurs
Document Store8Indexation vectorielle Qdrant
Outils5Outils MCP personnalises
Variables4Configuration
Credentials4Gestion des secrets
Stats3Analytics
Compliance3Conformite EU
Health5Monitoring 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