認証

ユーザーが実際のAPIキーを使用できるように、認証パラメータを設定できます。

認証を有効にする

docs.json に認証方式を追加して、全ページでグローバルに有効化することも、ページ単位で設定することもできます。

ページの認証方式は、両方が設定されている場合、グローバル設定より優先されます。

ベアラートークン

docs.json

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

Basic認証

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"
---