身份验证

你可以设置身份验证参数，让用户使用他们的真实 API 密钥。

启用身份验证

你可以在 docs.json 中添加一种身份验证方式，以在所有页面上全局启用；也可以为每个页面单独配置。

如果同时设置了全局方式和页面级方式，则页面的身份验证方式将覆盖全局设置。

Bearer 令牌

docs.json

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

基本身份验证

docs.json

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

API 密钥

docs.json

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

None

在 docs.json 中设置默认身份验证方式后，可通过使用 “none” 身份验证方法来对特定端点禁用身份验证。

Page Metadata

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