Support

Pergunte à nossa documentação

Pergunte ao nosso assistente de IA que foi treinado em nossa documentação.

Widget do painel

Envie-nos uma mensagem do seu painel. Selecione Support na barra lateral do seu painel.

Envie-nos um e-mail

Se você não conseguir acessar seu painel, envie-nos um e-mail para [e-mail].

Pergunte à IA

Junte-se à nossa comunidade e pergunte ao nosso assistente de IA que foi treinado em nossa documentação.

YouTube

Assista tutoriais e guias em nosso canal do YouTube.

Perguntas Frequentes

Problemas com o aplicativo do GitHub

O aplicativo do GitHub pode ser temperamental e redefinir a conexão é uma ótima maneira de resolver problemas.

1. Desinstale o aplicativo Mintlify através do GitHub

   1. No GitHub, vá para installations e selecione Configure ao lado do aplicativo Mintlify. Role para baixo e selecione Uninstall.
   2. Vá para Authorized GitHub Apps e selecione Revoke ao lado do aplicativo Mintlify.
2. Reinstale o aplicativo Mintlify

   1. No seu painel Mintlify, vá para Git Settings e instale o aplicativo do GitHub.
   2. Autorize sua conta na seção My Profile do seu painel.

Problemas com a página da API

As páginas da API são complicadas. Como resultado, há muitas coisas que podem dar errado. Aqui está uma lista de problemas comuns que vimos os clientes enfrentarem:

Todas as minhas páginas OpenAPI estão completamente em branco

Neste cenário, é provável que o Mintlify não consiga encontrar seu documento OpenAPI ou que seu documento OpenAPI seja inválido.

Executar mint dev localmente deve revelar alguns desses problemas.

Para verificar se seu documento OpenAPI passará na validação:

1. Execute mint openapi-check <openapiFilenameOrUrl> no seu CLI.
2. Valide sua especificação OpenAPI com o Swagger Editor.

Além disso, o Mintlify não suporta OpenAPI 2.0. Se seu documento usa OpenAPI 2.0, você pode encontrar esse problema. Você pode converter seu documento com o Swagger Editor.

Uma das minhas páginas OpenAPI está completamente em branco

Isso geralmente é causado por um campo openapi mal escrito nos metadados da página. Certifique-se de que o método HTTP e o caminho correspondam exatamente ao método HTTP e ao caminho no documento OpenAPI.

Aqui está um exemplo de como as coisas podem dar errado:

get-user.mdx

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

openapi.yaml

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

Observe que o caminho no campo openapi tem uma barra no final, enquanto o caminho no documento OpenAPI não tem.

Outro problema comum é um nome de arquivo mal escrito. Se você estiver especificando um documento OpenAPI específico no campo openapi, certifique-se de que o nome do arquivo esteja correto. Por exemplo, se você tiver dois documentos OpenAPI openapi/v1.json e openapi/v2.json, seus metadados podem parecer assim:

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

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

As solicitações do API Playground não funcionam

Se você tiver um domínio personalizado configurado, isso pode ser um problema com seu proxy reverso. Por padrão, as solicitações feitas através do API Playground começam com uma solicitação POST para o caminho /api/request no site da documentação. Se seu proxy reverso estiver configurado para permitir apenas solicitações GET, então todas essas solicitações falharão. Para corrigir isso, configure seu proxy reverso para permitir solicitações POST para o caminho /api/request.

Alternativamente, se seu proxy reverso impedir você de aceitar solicitações POST, você pode configurar o Mintlify para enviar solicitações diretamente para seu backend com a configuração api.playground.proxy no docs.json. Veja as configurações para o playground da API para mais informações. Isso provavelmente exigirá que você configure o CORS em seu servidor, pois essas solicitações agora virão diretamente dos navegadores dos seus usuários.

A página de documentação não carrega (erro 404)

Verifique se você tem /api na URL. Esta é uma pasta reservada em ambientes de produção, o que produz um erro 404.

Problemas ao adicionar SVG a um cartão

Nós suportamos um tipo específico de SVG, chamado JSX, e como tal, a imagem precisará ser convertida.

1. Use o conversor SVGR para gerar código SVG compatível com JSX.
2. Copie o código dentro da tag <svg/>.

3. Cole o código em seu cartão. Certifique-se de copiar e colar apenas o código dentro da tag <svg/>.
4. Você pode precisar diminuir a altura e a largura para fazer a imagem caber.

Fazemos o nosso melhor para responder a todas as solicitações dentro de 24 horas, mas podem ocorrer atrasos durante períodos de maior movimento.