Swagger

Riferimento rapido per consultare ed esplorare le API HTTP del backend.

Link relativo Swagger UI

• Swagger UI: /swagger
• OpenAPI JSON: /swagger/v1/swagger.json

Disponibilità per ambiente

• Swagger UI e OpenAPI JSON sono attivi solo con ASPNETCORE_ENVIRONMENT=Development: sviluppo locale (dotnet run / dotnet watch con il profilo di launchSettings.json) oppure pacchetto sorgenti avviato in debug.
• In Production (installazioni IIS e Linux, demo) Swagger è spento per sicurezza: /swagger/, /swagger/index.html e /swagger/v1/swagger.json rispondono 404, anche a un amministratore autenticato. Lo schema elencherebbe l'intera superficie API, comprese le azioni amministrative (es. /api/Meta/Restart, ReloadLicenseFromAppsettings).
• Per esplorare le API usa quindi un ambiente Development; non impostare Development su un'installazione raggiungibile dall'esterno per riaccendere Swagger.

Quando usarlo

• Verifica endpoint disponibili e payload attesi.
• Debug rapido di request/response durante integrazione frontend.
• Controllo route API dopo scaffolding, refactor o update metadata.

Relazione con Metadata e Scaffolding

• Dopo setup iniziale conviene validare gli endpoint principali da Swagger per confermare che l'host attivo sia quello corretto.
• In scenari metadata-driven, Swagger aiuta a verificare endpoint tecnici (MetaService, API custom) usati dalle route.
• Riferimenti utili:

- Metadata

- Scaffolding iniziale

Nota ambiente locale

• Se frontend e backend girano su host/porte diverse, il link relativo /swagger funziona quando passi dal gateway/proxy giusto.
• In alternativa, usa l'URL assoluto dell'istanza backend attiva (es. http://localhost:5000/swagger).