Configuration

O Mintlify permite que você defina seus endpoints de API usando uma combinação de configuraçãodocs.json, campos de metadados MDX e o componente<ParamFields />. A partir dos endpoints definidos, geramos um playground de API, exemplos de requisição e exemplos de resposta.

1. Configure sua API

   No seu arquivodocs.json, defina sua URL base e 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 você não quiser mostrar um playground de API, não precisa incluir tipos de autenticação. Oculte o playground com o seguinte campo:

   "api": {
     "playground": {
       "display": "none"
     }
   }

   Encontre uma lista completa de configurações de APIaqui.

2. Crie suas páginas de endpoint

   Cada página de endpoint de API deve ter um arquivo MDX correspondente. No topo de cada arquivo, defina:

   ---
   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 caminho, envolvido com{}:

   https://api.example.com/v1/endpoint/{userId}

   Se você tiverserverconfigurado emdocs.json, você pode usar caminhos relativos como/v1/endpoint.

   Você também pode substituir o modo de exibição definido globalmente para o playground da API por página adicionandoplaygroundno topo do arquivo MDX:

   ---
   title: 'Create new user'
   api: 'POST https://api.mintlify.com/user'
   playground: 'none'

3. Adicione seus endpoints à sua documentação

   Adicione suas páginas de endpoint à barra lateral adicionando os caminhos ao camponavigationno seudocs.json. Saiba mais sobre como estruturar sua documentaçãoaqui.