---
title: Ejemplo de OpenAPI
description: "Consulta una página de endpoint generada con OpenAPI y aprende cómo Jamdesk renderiza solicitudes, respuestas y autenticación desde tu especificación."
openapi: /openapi/example-api.yaml POST /tickets
---

Esta página demuestra un endpoint en vivo generado a partir de una [especificación OpenAPI](https://spec.openapis.org/oas/latest.html). El esquema de solicitud, los modelos de respuesta y los ejemplos de código del panel derecho se generan automáticamente desde la especificación, sin necesidad de autoría manual.

<Info>
Este ejemplo utiliza la API de soporte de Acme. Actualiza `api.openapi` en tu `docs.json` para apuntar a tu propio archivo de especificación y generar endpoints reales.
</Info>

<Info>
**¿Documentación en varios idiomas?** Proporciona un archivo `<spec>.<lang>.<ext>` junto a tu especificación fuente (p. ej., `example-api.fr.yaml`) y Jamdesk renderiza la versión traducida cuando los usuarios visitan la página bajo `/fr/...`. Consulta [Traducción de especificaciones OpenAPI](/es/setup/languages#traducci-n-de-especificaciones-openapi).
</Info>

<Tip>
Esta página tiene el [API Playground](/es/api-reference/playground) habilitado. Haz clic en **Pruébalo** en el endpoint de arriba para probar la API en vivo.
</Tip>

## Qué se genera

A partir de una sola línea `openapi` en el frontmatter, Jamdesk genera automáticamente:

- Un distintivo de endpoint que muestra el método y la ruta con codificación de colores
- Documentación de parámetros de ruta, consulta, encabezado y cuerpo
- Esquemas de solicitud y respuesta, incluidos objetos y arrays anidados
- Ejemplos de código en cURL, Python, JavaScript, Go, Ruby, C#, Java, Rust y PHP (configurable mediante `api.examples.languages`)
- Detalles de autenticación extraídos de los esquemas de seguridad de la especificación

Todas las referencias `$ref` en tu especificación se resuelven automáticamente, por lo que puedes organizar esquemas con `components/schemas` como de costumbre.

## Configuración de OpenAPI

Coloca tu especificación OpenAPI 3.x (YAML o JSON) en el directorio `openapi/`, regístrala en `docs.json` bajo `api.openapi` y luego añade `openapi: /openapi/your-spec.yaml METHOD /path` al frontmatter de cualquier página. Consulta la [guía de configuración de OpenAPI](/es/setup/directory-structure#openapi) para obtener todos los detalles.

## Páginas relacionadas

<Columns cols={2}>
  <Card title="API Playground" icon="flask-vial" href="/es/api-reference/playground">
    Habilita las pruebas interactivas de API en tus páginas de endpoint
  </Card>
  <Card title="Ejemplos de solicitud/respuesta" icon="code" href="/es/api-reference/request-response-examples">
    Ejemplo de endpoint escrito manualmente con componentes MDX
  </Card>
</Columns>

<Columns cols={2}>
  <Card title="Configuración de OpenAPI" icon="file-code" href="/es/setup/directory-structure#openapi">
    Dónde almacenar y referenciar archivos OpenAPI
  </Card>
  <Card title="Referencia de docs.json" icon="file-lines" href="/es/config/docs-json-reference">
    Referencia de configuración completa, incluido api.openapi
  </Card>
</Columns>