---
title: Esempio OpenAPI
description: Visualizza un endpoint OpenAPI generato in tempo reale e scopri come Jamdesk esegue il rendering di richieste, risposte e autenticazione dalla tua specifica.
openapi: /openapi/example-api.yaml POST /tickets
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

Questa pagina mostra un endpoint in tempo reale generato da una [specifica OpenAPI](https://spec.openapis.org/oas/latest.html). Lo schema della richiesta, i modelli della risposta e gli esempi di codice nel pannello a destra vengono generati automaticamente dalla specifica, senza bisogno di scrivere manualmente alcun contenuto.

<Info>
Questo esempio usa l'API di supporto Acme. Aggiorna `api.openapi` nel tuo `docs.json` in modo che punti al tuo file di specifica per generare endpoint reali.
</Info>

<Info>
**Documentazione multilingue?** Fornisci un file `<spec>.<lang>.<ext>` accanto alla specifica originale, ad esempio `example-api.fr.yaml`, e Jamdesk mostrerà la versione tradotta quando gli utenti visualizzano la pagina all'indirizzo `/fr/...`. Consulta [Traduzione delle specifiche OpenAPI](/it/setup/languages#traduzione-delle-specifiche-openapi).
</Info>

<Tip>
Questa pagina ha [API Playground](/it/api-reference/playground) abilitato. Fai clic su **Try it** sull'endpoint qui sopra per testare l'API in tempo reale.
</Tip>

## Contenuti generati

Da una singola riga `openapi` nel frontmatter, Jamdesk genera automaticamente:

- Un badge dell'endpoint che mostra il metodo e il percorso con codifica a colori
- La documentazione dei parametri di percorso, query, header e corpo
- Gli schemi della richiesta e della risposta, inclusi oggetti e array annidati
- Esempi di codice in cURL, Python, JavaScript, Go, Ruby, C#, Java, Rust e PHP, configurabili tramite `api.examples.languages`
- I dettagli di autenticazione ricavati dagli schemi di sicurezza della specifica

Tutti i riferimenti `$ref` nella specifica vengono risolti automaticamente, così puoi organizzare gli schemi con `components/schemas` come di consueto.

## Configurazione di OpenAPI

Inserisci la specifica OpenAPI 3.x, in formato YAML o JSON, nella directory `openapi/`, registrala in `docs.json` sotto `api.openapi`, quindi aggiungi `openapi: /openapi/your-spec.yaml METHOD /path` al frontmatter di qualsiasi pagina. Consulta la [guida alla configurazione di OpenAPI](/it/setup/directory-structure#openapi) per tutti i dettagli.

<Tip>
  Scrivi la specifica in YAML? Eseguila tramite il [validatore YAML](https://jamdesk.com/utilities/yaml-validator) gratuito per individuare errori di indentazione e sintassi prima che la build la analizzi.
</Tip>

## Pagine correlate

<Columns cols={2}>
  <Card title="API Playground" icon="flask-vial" href="/it/api-reference/playground">
    Abilita i test interattivi dell'API nelle pagine degli endpoint
  </Card>
  <Card title="Esempi di richieste e risposte" icon="code" href="/it/api-reference/request-response-examples">
    Esempio di endpoint scritto manualmente usando componenti MDX
  </Card>
</Columns>

<Columns cols={2}>
  <Card title="Configurazione OpenAPI" icon="file-code" href="/it/setup/directory-structure#openapi">
    Dove archiviare e utilizzare i file OpenAPI
  </Card>
  <Card title="Riferimento di docs.json" icon="file-lines" href="/it/config/docs-json-reference">
    Riferimento completo alla configurazione, incluso api.openapi
  </Card>
</Columns>

---

📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://jamdesk-docs.jamdesk.app/api-specs.zip