OpenAPI 仕様を使わずに、個別の MDX ファイルで API エンドポイントを手動定義できます。この方法はカスタムコンテンツに柔軟ですが、保守性と機能性の観点から、ほとんどのプロジェクトでは OpenAPI 仕様ファイルから API ドキュメントを生成することを推奨します。とはいえ、小規模な API のドキュメント化やプロトタイピングには、MDX でページを作成する方法が有用です。 MDX で API エンドポイントのページを生成するには、docs.json で API 設定を行い、各エンドポイントごとに MDX ファイルを作成し、<ParamFields /> などのコンポーネントでパラメータを定義します。これらの定義から、Mintlify はインタラクティブな APIプレイグラウンド、リクエスト例、レスポンス例を生成します。
1

API を設定する

docs.json ファイルで、ベース URL と認証方式を定義します:
 "api": {
  "mdx": {
    "server": "https://mintlify.com/api", // 複数のベース URL の場合は文字列配列
    "auth": {
      "method": "key",
      "name": "x-api-key" // オプション: bearer, basic, key
    }
  }
}
APIプレイグラウンドを非表示にしたい場合は、display フィールドを使用します。プレイグラウンドを非表示にする場合は、認証方式の設定は不要です。
"api": {
  "playground": {
    "display": "none"
  }
}
API 設定の一覧は Settings を参照してください。
2

エンドポイントページを作成する

各 API エンドポイントページには対応する MDX ファイルが必要です。各ファイルの先頭（フロントマター）で title と api を定義します:
---
title: 'Create new user'
api: 'POST https://api.mintlify.com/user'
---
パスパラメータは、パス中にパラメータ名を {} で囲んで指定します:
https://api.example.com/v1/endpoint/{userId}
docs.json に server フィールドが設定されている場合は、/v1/endpoint のような相対パスを使用できます。
フロントマターに playground を追加すると、そのページに限り APIプレイグラウンドのグローバル表示モードを上書きできます:
---
title: 'Create new user'
api: 'POST https://api.mintlify.com/user'
playground: 'none'
---
  • playground: 'interactive' - インタラクティブなプレイグラウンドを表示
  • playground: 'simple' - プレイグラウンドなしでコピー可能なエンドポイントを表示
  • playground: 'none' - プレイグラウンドを非表示
3

エンドポイントをドキュメントに追加する

docs.json の navigation フィールドにパスを追加して、エンドポイントページをサイドバーに表示します。ドキュメント構成の詳細は Navigation を参照してください。

​
認証の有効化

docs.json に認証方式を追加して、すべてのページでグローバルに有効化することも、ページごとに設定することもできます。 ページの認証方式は、両方が設定されている場合、グローバル設定を上書きします。

​
ベアラー・トークン

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

​
Basic認証

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

​
APIキー

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

​
None

none 認証メソッドは、docs.json でデフォルトを設定した後に、特定のエンドポイントだけ認証を無効にするのに便利です。 
---
title: "Your page title"
authMethod: "none"
---