Você pode definir endpoints de API manualmente em arquivos MDX individuais em vez de usar uma especificação OpenAPI. Esse método oferece flexibilidade para conteúdo personalizado, mas recomendamos gerar a documentação da API a partir de um arquivo de especificação OpenAPI para a maioria dos projetos, pois é mais fácil de manter e mais rico em recursos. Ainda assim, criar páginas MDX para uma API pode ser útil para documentar APIs pequenas ou para prototipagem. Para gerar páginas para endpoints de API usando MDX, configure as definições da sua API em docs.json, crie arquivos MDX individuais para cada endpoint e use componentes como <ParamFields /> para definir parâmetros. A partir dessas definições, a Mintlify gera playgrounds de API interativos, exemplos de requisição e de resposta.
1

Configure sua API

No seu arquivo docs.json, defina sua URL base e o método de autenticação:
 "api": {
  "mdx": {
    "server": "https://mintlify.com/api", // string array for multiple base URLs
    "auth": {
      "method": "key",
      "name": "x-api-key" // options: bearer, basic, key.
    }
  }
}
Se quiser ocultar o playground de API, use o campo display. Você não precisa incluir um método de autenticação se ocultar o playground.
"api": {
  "playground": {
    "display": "none"
  }
}
Encontre a lista completa de configurações de API em Settings.
2

Crie as páginas dos seus endpoints

Cada página de endpoint da API deve ter um arquivo MDX correspondente. No topo de cada arquivo, defina title e api:
---
title: 'Create new user'
api: 'POST https://api.mintlify.com/user'
---
Você pode especificar parâmetros de caminho adicionando o nome do parâmetro ao path, envolvido por {}:
https://api.example.com/v1/endpoint/{userId}
Se você tiver um campo server configurado em docs.json, poderá usar caminhos relativos como /v1/endpoint.
Você pode substituir o modo de exibição global do playground de API para uma página adicionando playground ao frontmatter:
---
title: 'Create new user'
api: 'POST https://api.mintlify.com/user'
playground: 'none'
---
  • playground: 'interactive' - Exibe o playground interativo.
  • playground: 'simple' - Exibe um endpoint copiável sem playground.
  • playground: 'none' - Oculta o playground.
3

Adicione seus endpoints à documentação

Adicione as páginas dos seus endpoints à barra lateral incluindo os caminhos no campo navigation do seu docs.json. Saiba mais sobre como estruturar sua documentação em Navigation.

​
Ativando a autenticação

Você pode adicionar um método de autenticação ao seu docs.json para habilitá-la globalmente em todas as páginas ou defini-la individualmente por página. O método de autenticação de uma página substituirá o método global se ambos estiverem definidos.

​
Token Bearer

"api": {
    "mdx": {
      "auth": {
        "method": "bearer"
      }
    }
}

​
Autenticação básica

"api": {
    "mdx": {
      "auth": {
        "method": "basic"
      }
    }
}

​
Chave da API

"api": {
    "mdx": {
      "auth": {
        "method": "key",
        "name": "x-api-key"
      }
    }
}

​
None

O método de autenticação none é útil para desativar a autenticação em um endpoint específico depois de definir um padrão no docs.json. 
---
title: "Your page title"
authMethod: "none"
---