Swagger

Swagger - documentazione operativa e tecnica

advancedstable

Overview

Swagger

Quick reference for consulting and exploring the backend HTTP APIs.

Swagger UI Relative Link

When to Use It

  • Verify available endpoints and expected payloads.
  • Quick debugging of request/response during frontend integration.
  • Check API routes after scaffolding, refactoring, or metadata update.

Relationship with Metadata and Scaffolding

  • After initial setup, it is advisable to validate the main endpoints from Swagger to confirm that the active host is the correct one.
  • In metadata-driven scenarios, Swagger helps verify technical endpoints (MetaService, custom APIs) used by routes.
  • Useful references:

- Metadata

- Initial Scaffolding

Local Environment Note

  • If frontend and backend run on different hosts/ports, the relative /swagger link works when you go through the correct gateway/proxy.
  • Alternatively, use the absolute URL of the active backend instance (e.g., http://localhost:5000/swagger).