Skip to content

Riferimento API

La simulazione espone una superficie FastAPI. Documentazione OpenAPI interattiva (Swagger UI):

Swagger UI

Sullo stesso host dell’app, percorso /docs:

Non confondere

Questa guida utente è disponibile sotto /docs/… (DE), /docs/en/…, /docs/fr/…, /docs/it/…. Swagger OpenAPI si trova sotto /docs (percorso root).

Simulazione

EndpointScopo
GET /catalogBrand e componenti
GET /defaultsDefault, limiti slider, reference_setups
POST /simulate/steadyCurve in regime stazionario inclusi max_speed / max_speed_kmh (Vmax)
POST /simulate/pumpIntegrazione del ciclo di pump
POST /simulate/optimumRicerca dell’ottimo di pump
POST /simulate/compareFino a tre setup affiancati

Analisi (MVP+)

EndpointScopo
POST /analyze/tradeoffTrade-off tra setup di base e candidato
POST /analyze/tradeoff/referenceTrade-off vs. rig di riferimento (es. PNGv2 1400)
POST /analyze/pump-coachScore pump, scostamenti, consigli, patch di ottimo

Gli endpoint di analisi restituiscono dati strutturati con campi message_key per la localizzazione UI — nessuna stringa UI hardcoded nell’API.

POST /analyze/tradeoff (focus high_speed) pesa di più la metrica max_speed_kmh e il drag totale rispetto al solo picco L/D.

Disponibili anche sotto /api/….

Primi passi · Metriche · Vmax

I confronti tra setup sono più affidabili dei valori assoluti.