Ejemplo de OpenAPI
Consulta una página de endpoint generada en vivo con OpenAPI y descubre cómo Jamdesk renderiza solicitudes, respuestas y autenticación directamente desde tu spec.
Create a new ticket for a customer issue or request.
Body
customer_idstringrequiredCustomer identifier in Acme.
subjectstringrequiredShort summary of the issue.
priority"low" | "normal" | "high" | "urgent""low" | "normal" | "high" | "urgent"tagsarray<string>messagestringrequiredDetailed problem description.
Response
Ticket created
idstringcustomer_idstringsubjectstringprioritystringstatus"open" | "pending" | "resolved""open" | "pending" | "resolved"tagsarray<string>messagestringcreated_atstring<date-time>updated_atstring<date-time>Esta página muestra un endpoint en vivo generado a partir de una especificación OpenAPI. El esquema de la solicitud, los modelos de respuesta y los ejemplos de código del panel derecho se generan automáticamente desde el spec, sin necesidad de escribir nada a mano.
Este ejemplo utiliza la Acme Support API. Actualiza api.openapi en tu docs.json para apuntar a tu propio archivo de spec y generar endpoints reales.
Esta página tiene activado el API Playground: haz clic en Try it 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:
- Insignia del endpoint: método y ruta con códigos de color
- Documentación de parámetros: parámetros de ruta, query, header y body
- Esquemas de solicitud y respuesta: incluidos objetos anidados y arrays
- Ejemplos de código: cURL, Python, JavaScript, Go, Ruby, C#, Java, Rust, PHP (configurables mediante
api.examples.languages) - Detalles de autenticación: extraídos de los esquemas de seguridad del spec
Todas las referencias $ref de tu spec se resuelven automáticamente, así que puedes organizar los esquemas con components/schemas como de costumbre.
Configurar OpenAPI
Coloca tu spec OpenAPI 3.x (YAML o JSON) en el directorio openapi/, regístralo en docs.json bajo api.openapi y 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 ver todos los detalles.