OpenAPI e Swagger (2): come funziona Swagger UI con la demo Petstore

Giovanni Pace

Descrizione

Swagger UI è l'interfaccia interattiva che legge una specifica OpenAPI e la rende consultabile e provabile dal browser. La smontiamo sulla demo Petstore (OpenAPI 3.0): info dell'API, endpoint raggruppati per tag, schemas, parametri e codici di risposta, poi lanciamo le chiamate con Try it out e le rifacciamo in Postman per vedere che il risultato è identico.

Cosa imparerai

  • I tre blocchi di una Swagger UI: descrizione, lista degli endpoint e schemas
  • Come leggere metodo HTTP, endpoint, parametri obbligatori e tipi (integer int64)
  • Le response documentate: 200, 400, 404 e l'unexpected error di default
  • Try it out ed Execute: la curl generata, la request URL e la response reale
  • Perché alcuni endpoint hanno il lucchetto e richiedono il login
  • Perché la stessa chiamata in Postman dà lo stesso risultato, e cosa ci guadagna il frontend