Ejemplo de OpenAPI
Consulta una página de endpoint generada en vivo con OpenAPI y aprende cómo Jamdesk renderiza solicitudes, respuestas y autenticación directamente desde tu especificación.
Crear un nuevo ticket para un problema o solicitud de un cliente.
Body
customer_idstringrequiredIdentificador del cliente en Acme.
subjectstringrequiredResumen breve del problema.
priority"low" | "normal" | "high" | "urgent""low" | "normal" | "high" | "urgent"tagsarray<string>messagestringrequiredDescripción detallada del problema.
Response
Ticket creado
idstringcustomer_idstringsubjectstringprioritystringstatus"open" | "pending" | "resolved""open" | "pending" | "resolved"tagsarray<string>messagestringcreated_atstring<date-time>updated_atstring<date-time>Esta página demuestra un endpoint en vivo generado a partir de una especificación OpenAPI. 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.
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.
¿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.
Esta página tiene el API Playground habilitado. Haz clic en Pruébalo en el endpoint de arriba para probar la API en vivo.
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 para obtener todos los detalles.