OpenAPI

Fumadocs 支持从 OpenAPI schema 自动生成文档，兼容 OpenAPI 3.0 和 3.1 版本。

安装

npm i fumadocs-openapi shiki

样式配置

在 Tailwind CSS 中添加：

@import 'fumadocs-openapi/css/preset.css';

服务端设置

通过初始化 schema 文件创建 OpenAPI 实例：

import { createOpenAPI } from 'fumadocs-openapi/server';

export const openapi = createOpenAPI({
  input: ['./unkey.json'],
});

文档生成

有两种方式：

静态生成：通过脚本直接从 schema 生成 MDX 文件，然后在 MDX 配置中包含 APIPage 组件。

动态生成：通过 Loader API 的 openapiSource() 函数集成 OpenAPI 页面，允许随 schema 变化实时更新。

支持的功能

• 端点元数据展示
• 交互式请求 Playground
• 多语言代码示例
• 基于 Schema 的响应示例和 TypeScript 类型定义
• 自动生成的请求参数和请求体文档

子页面：

• APIPage 组件
• generateFiles()
• createOpenAPI()