Skip to content

Référence API

La simulation expose une surface FastAPI. Documentation OpenAPI interactive (Swagger UI) :

Swagger UI

Sur le même hôte que l’app, chemin /docs :

Ne pas confondre

Ce guide utilisateur est disponible sous /docs/… (DE), /docs/en/…, /docs/fr/…, /docs/it/…. Swagger OpenAPI se trouve sous /docs (chemin racine).

Endpoints (résumé)

Simulation

EndpointRôle
GET /catalogMarques et composants
GET /defaultsValeurs par défaut, bornes des curseurs, reference_setups
POST /simulate/steadyCourbes en régime permanent, y compris max_speed / max_speed_kmh (Vmax)
POST /simulate/pumpIntégration du cycle de pump
POST /simulate/optimumRecherche d’optimum de pump
POST /simulate/compareJusqu’à trois setups côte à côte

Analyse (MVP+)

EndpointRôle
POST /analyze/tradeoffTrade-offs entre setup de base et candidat
POST /analyze/tradeoff/referenceTrade-off vs. rig de référence (p. ex. PNGv2 1400)
POST /analyze/pump-coachScore pump, écarts, conseils, patch d’optimum

Les endpoints d’analyse renvoient des données structurées avec des champs message_key pour la localisation UI — aucune chaîne UI en dur dans l’API.

POST /analyze/tradeoff (focus high_speed) pondère davantage la métrique max_speed_kmh et la traînée totale que le seul pic L/D.

Également disponibles sous /api/….

Premiers pas · Indicateurs · Vmax

Les comparaisons entre setups sont plus fiables que les valeurs absolues.