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

配置你的 API

在 docs.json 文件中定义基础 URL 和认证方式：
如果你想隐藏 API交互测试台，请使用 display 字段。隐藏交互测试台时无需配置认证方式。
在 Settings 中查看完整的 API 配置项列表。
2

创建端点页面

每个 API 端点页面应有一个对应的 MDX 文件。在文件头部（frontmatter）定义 title 和 api：
你可以通过在路径中加入参数名并用 {} 包裹来指定路径参数：
如果你在 docs.json 中配置了 server 字段，你可以使用相对路径（例如 /v1/endpoint）。
你可以在该页面的 frontmatter 中添加 playground 来覆盖全局的 API交互测试台显示模式：
  • playground: 'interactive' - 显示交互式测试台。
  • playground: 'simple' - 仅显示可复制的端点，不包含测试台。
  • playground: 'none' - 隐藏测试台。
3

将端点添加到文档中

将这些页面的路径添加到 docs.json 的 navigation 字段中，以显示在侧边栏。在 Navigation 中了解更多文档结构的组织方式。

​
启用认证

你可以在 docs.json 中添加一种认证方式，使其在所有页面全局生效，或者按页面单独配置。 如果同时设置了全局和页面级的认证方式，页面级设置将覆盖全局设置。

​
Bearer token

​
Basic authentication

​
API key

​
None

在 docs.json 中设置默认认证后，none 方式可用于在特定端点禁用认证。