认证

你可以配置认证参数，让用户使用其实际的 API key。

​

启用认证

你可以在 docs.json 中添加一种认证方式，将其全局应用于每个页面；也可以按页面单独设置。

当同时存在全局与页面级设置时，页面的认证方式会覆盖全局设置。

​

Bearer 令牌

docs.json

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

​

基本认证

docs.json

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

​

API key

docs.json

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

​

无

在 docs.json 中设置默认值后，可通过将认证方式设为 “none” 来为特定端点禁用认证。

Page Metadata

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