Support

Consulte nuestra documentación

Consulte a nuestro asistente de IA que ha sido entrenado con nuestra documentación.

Widget del panel de control

Envíenos un mensaje desde su panel de control. Seleccione Soporte en la barra lateral de su panel de control.

Envíenos un correo electrónico

Si no puede acceder a su panel de control, envíenos un correo electrónico a [e-mail].

Preguntar a la IA

Únase a nuestra comunidad y consulte a nuestro asistente de IA que ha sido entrenado con nuestra documentación.

YouTube

Vea tutoriales y guías en nuestro canal de YouTube.

Preguntas frecuentes

Problemas con la aplicación de GitHub

La aplicación de GitHub puede ser temperamental y restablecer la conexión es una excelente manera de resolver problemas.

1. Desinstalar la aplicación Mintlify a través de GitHub

   1. En GitHub, vaya a installations y seleccione Configure junto a la aplicación Mintlify. Desplácese hacia abajo y seleccione Uninstall.
   2. Vaya a Authorized GitHub Apps y seleccione Revoke junto a la aplicación Mintlify.
2. Reinstalar la aplicación Mintlify

   1. En su panel de control de Mintlify, vaya a Git Settings e instale la aplicación de GitHub.
   2. Autorice su cuenta en la sección My Profile de su panel de control.

Problemas con la página de API

Las páginas de API son complicadas. Como resultado, hay muchas cosas que pueden salir mal. Aquí hay una lista de problemas comunes que hemos visto que los clientes enfrentan:

Todas mis páginas de OpenAPI están completamente en blanco

En este escenario, es probable que Mintlify no pueda encontrar su documento OpenAPI o que su documento OpenAPI no sea válido.

Ejecutar mint dev localmente debería revelar algunos de estos problemas.

Para verificar que su documento OpenAPI pase la validación:

1. Ejecute mint openapi-check <openapiFilenameOrUrl> en su CLI.
2. Valide su especificación OpenAPI con Swagger Editor.

Además, Mintlify no admite OpenAPI 2.0. Si su documento utiliza OpenAPI 2.0, es posible que encuentre este problema. Puede convertir su documento con Swagger Editor.

Una de mis páginas de OpenAPI está completamente en blanco

Esto generalmente es causado por un campo openapi mal escrito en los metadatos de la página. Asegúrese de que el método HTTP y la ruta coincidan exactamente con el método HTTP y la ruta en el documento OpenAPI.

Aquí hay un ejemplo de cómo las cosas podrían salir mal:

get-user.mdx

---
openapi: "GET /users/{id}/"
---

openapi.yaml

paths:
  "/users/{id}":
    get: ...

Observe que la ruta en el campo openapi tiene una barra diagonal al final, mientras que la ruta en el documento OpenAPI no la tiene.

Otro problema común es un nombre de archivo mal escrito. Si está especificando un documento OpenAPI particular en el campo openapi, asegúrese de que el nombre del archivo sea correcto. Por ejemplo, si tiene dos documentos OpenAPI openapi/v1.json y openapi/v2.json, sus metadatos podrían verse así:

api-reference/v1/users/get-user.mdx

---
openapi: "v1 GET /users/{id}"
---

Las solicitudes desde el API Playground no funcionan

Si tiene configurado un dominio personalizado, esto podría ser un problema con su proxy inverso. Por defecto, las solicitudes realizadas a través del API Playground comienzan con una solicitud POST a la ruta /api/request en el sitio de documentación. Si su proxy inverso está configurado para permitir solo solicitudes GET, entonces todas estas solicitudes fallarán. Para solucionarlo, configure su proxy inverso para permitir solicitudes POST a la ruta /api/request.

Alternativamente, si su proxy inverso le impide aceptar solicitudes POST, puede configurar Mintlify para enviar solicitudes directamente a su backend con la configuración api.playground.proxy en el docs.json. Consulte las configuraciones para el API playground para obtener más información. Esto probablemente requerirá que configure CORS en su servidor, ya que estas solicitudes ahora vendrán directamente de los navegadores de sus usuarios.

La página de documentación no carga (error 404)

Verifique si tiene /api en la URL. Esta es una carpeta reservada en entornos de producción, lo que produce un error 404.

Problemas al agregar SVG a una tarjeta

Admitimos un tipo específico de SVG, llamado JSX, y como tal, la imagen deberá ser convertida.

1. Use el conversor SVGR para generar código SVG compatible con JSX.
2. Copie el código dentro de la etiqueta <svg/>.

3. Pegue el código en su tarjeta. Asegúrese de copiar y pegar solo el código dentro de la etiqueta <svg/>.
4. Es posible que necesite disminuir la altura y el ancho para que la imagen se ajuste.

Hacemos nuestro mejor esfuerzo para responder a todas las solicitudes dentro de las 24 horas, pero pueden ocurrir retrasos durante los períodos de mayor actividad.