跳转到主要内容
你可以在单独的 MDX 文件中手动定义 API 端点，而不是使用 OpenAPI 规范。此方法在自定义内容方面更灵活，但对于大多数项目，我们建议从 OpenAPI 规范文件生成 API 文档，因为这更易维护且功能更完善。不过，为 API 创建 MDX 页面在记录小型 API 或用于原型设计时依然很有用。 要使用 MDX 为 API 端点生成页面，请在 docs.json 中配置 API 设置，为每个端点创建单独的 MDX 文件，并使用如 <ParamFields /> 等组件定义参数。Mintlify 会基于这些定义生成交互式 API 操作台、请求示例和响应示例。
1

Configure your API

在 docs.json 文件中定义基础 URL 和认证方式：
 "api": {
  "mdx": {
    "server": "https://mintlify.com/api", // string array for multiple base URLs
    "auth": {
      "method": "key",
      "name": "x-api-key" // options: bearer, basic, key.
    }
  }
}
如果想隐藏 API 操作台，请使用 display 字段。隐藏操作台时无需包含认证方式。
"api": {
  "playground": {
    "display": "none"
  }
}
在 Settings 中查看完整的 API 配置列表。
2

Create your endpoint pages

每个 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 的相对路径。
你可以在 frontmatter 中添加 playground，以在某个页面覆盖全局定义的 API 操作台显示模式：
---
title: 'Create new user'
api: 'POST https://api.mintlify.com/user'
playground: 'none'
---
  • playground: 'interactive' - 显示交互式操作台。
  • playground: 'simple' - 显示可复制的端点，无操作台。
  • playground: 'none' - 隐藏操作台。
3

Add your endpoints to your docs

通过将路径添加到 docs.json 中的 navigation 字段，把端点页面加入侧边栏。参见 Navigation 了解更多文档结构相关信息。

​
启用认证

你可以在 docs.json 中添加认证方式，将其全局应用到每个页面；也可以为单个页面分别设置。 当同时设置了全局与页面级认证时，以页面级设置为准。

​
Bearer 令牌

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

​
基本身份验证

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

​
API 密钥

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

​
None

在 docs.json 中设置默认认证方式后，可通过将认证方法设为 none 来对特定端点禁用认证。 
---
title: "Your page title"
authMethod: "none"
---
⌘I