Autenticação

Você pode configurar parâmetros de autenticação para permitir que os usuários usem suas próprias chaves de API.

Habilitando a autenticação

Você pode adicionar um método de autenticação ao seu docs.json para habilitá-lo globalmente em todas as páginas ou defini-lo 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

docs.json

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

Autenticação básica

docs.json

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

Chave de API

docs.json

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

Nenhum

O método de autenticação “none” é útil para desativar a autenticação em um endpoint específico após você definir um padrão em docs.json.

Page Metadata

---
title: "Your page title"
authMethod: "none"
---