认证

你可以配置认证参数，让用户使用其真实的 API 密钥。

​

启用认证

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

当同时设置了全局方法和页面方法时，页面的认证方法会覆盖全局方法。

​

Bearer token

docs.json

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

​

Basic authentication

docs.json

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

​

API key

docs.json

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

​

None

在 docs.json 中设置默认值后，使用 “none” 认证方法可在某个特定端点上禁用认证。

Page Metadata

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