OpenAPI Spec Generator

Genera specifiche OpenAPI 3.0 da definizione visuale di endpoint.

Informazioni API

Endpoint

Parametri
Response

Output

{
  "openapi": "3.0.0",
  "info": {
    "title": "My API",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://api.example.com/v1"
    }
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "List all users",
        "operationId": "get_users",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    }
  }
}
← Tutti gli strumenti

Come utilizzare OpenAPI Spec Generator

Compila le informazioni API

Inserisci titolo, versione, server URL e descrizione: diventano i campi "info" e "servers" dello spec OpenAPI 3.0.

Aggiungi gli endpoint

Per ogni endpoint definisci path, metodo HTTP e summary, poi aggiungi parametri (query/path/header) e le risposte con i relativi status code.

Scegli il formato di output

Passa dal tab JSON al tab YAML per vedere l'anteprima live della spec generata nel formato scelto.

Copia o scarica la spec

Usa "Copia spec" per incollarla in Swagger Editor o "Scarica spec" per salvarla come file .json o .yaml.

Suggerimenti

  • L'operationId viene generato automaticamente combinando metodo e path (es. "getusers_id"): rinominalo manualmente dopo l'export se ti serve un nome più leggibile per l'SDK.
  • Marca come "required" i parametri path (es. {id}), altrimenti la spec risulterà tecnicamente valida ma incoerente con l'URL definito.
  • Dopo aver generato lo spec, incollalo nell'OpenAPI Validator del sito per controllare campi obbligatori, $ref e best practice prima di pubblicarlo.

Domande frequenti

Che versione di OpenAPI genera il tool?

Genera sempre specifiche OpenAPI 3.0.0 (campo "openapi": "3.0.0" fisso nell'output), a partire dalla definizione visuale di titolo, server, endpoint, parametri e risposte.

Posso definire un request body per POST/PUT/PATCH?

Sì, incollando uno schema JSON valido nel campo requestBody dell'endpoint: viene inserito automaticamente come "application/json" solo per i metodi POST, PUT e PATCH. Se il JSON non è valido, il campo viene semplicemente ignorato nello spec generato.

Cosa succede se non definisco nessuna risposta per un endpoint?

Il tool inserisce automaticamente una risposta di default "200: OK" in modo che lo spec generato resti sempre valido secondo la struttura OpenAPI.

Come viene generato l'output YAML?

Con un convertitore JSON-to-YAML scritto internamente al tool (nessuna libreria YAML esterna): l'oggetto spec viene serializzato ricorsivamente rispettando l'indentazione YAML standard.

I dati che inserisco vengono inviati a un server?

No, la generazione dello spec è interamente client-side: titolo, endpoint, parametri e risposte restano nel browser finché non copi o scarichi il risultato.