OpenAPI
OpenAPI スキーマからドキュメントを生成します。
セットアップ
必要なパッケージをインストールします。
npm i fumadocs-openapi shikiスタイルの生成
次の行を追加します。
@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';
@import 'fumadocs-openapi/css/preset.css';プラグインの設定
OpenAPI サーバーインスタンスと <OpenAPIPage /> コンポーネントを作成します。
import { createOpenAPI } from 'fumadocs-openapi/server';
// 注: これはサーバーサイドの API です
export const openapi = createOpenAPI({
// OpenAPI スキーマ。外部 URL を指定することもできます。
input: ['./openapi.json'],
});それぞれのオプションについては、createOpenAPI() と createOpenAPIPage() を参照してください。
ページを生成する
loader() に staticSource() を渡します。ファイルを書き出すことなくページを生成できます。
staticSource() はファイルを読み込むため、source.ts はサーバー専用になります。クライアントのコードからインポートできるように、docs を collections.ts に移動してください。
import { loader } from 'fumadocs-core/source';
import { defineDocs } from 'fumadocs-mdx/macro';
import { docs } from '@/lib/collections';
import { openapi } from '@/lib/openapi';
export const docs = defineDocs({
dir: 'content/docs',
docs: {
async: true,
},
});
// `staticSource()` がファイルを読み込むため、サーバー専用になります
export const source = loader(
{
docs: docs.toFumadocsSource(),
openapi: await openapi.staticSource({
baseDir: 'openapi',
}),
},
{
baseUrl: '/docs',
// 任意：ページツリーの各ページ項目にバッジを追加します
plugins: [openapi.loaderPlugin()],
},
);staticSource() は、デフォルトでオペレーションごとに1ページを生成します。カスタマイズする場合は、ページの生成を参照してください。
これにより、source のページは docs と openapi の2種類になります。 LLM 向けにテキストを返す箇所など、source を使用しているすべての箇所を更新してください。
import { llms } from 'fumadocs-core/source';
import { source } from '@/lib/source';
export const docsLlms = llms(source, {
renderPage: (page) => {
if (page.type === 'openapi') {
// 例: 文字列化した OpenAPI スキーマを返す
return JSON.stringify(page.data.getSchema().bundled, null, 2);
}
// 以下は既存の処理...
},
});ドキュメントページで <OpenAPIPage /> を使用して OpenAPI ページをレンダリングします。
import { docs, source } from '@/lib/source';
import { docs } from '@/lib/collections';
import { source } from '@/lib/source';
import { OpenAPIPage } from '@/components/api-page';
export const Route = createFileRoute('/docs/$')({
component: Page,
loader: async ({ params }) => {
const slugs = params._splat?.split('/') ?? [];
const data = await serverLoader({ data: slugs });
if (data.type === 'docs') await docs.getPage(data.path)?.preload();
return data;
},
});
const serverLoader = createServerFn({
method: 'GET',
})
.validator((slugs: string[]) => slugs)
.handler(async ({ data: slugs }) => {
const page = source.getPage(slugs);
if (!page) throw notFound();
const pageTree = await source.serializePageTree(source.getPageTree());
if (page.type === 'openapi') {
return {
type: 'openapi',
title: page.data.title,
props: page.data.getOpenAPIPageProps(),
pageTree,
};
}
return { type: 'docs', path: page.path, pageTree };
});
function Page() {
const data = useFumadocsLoader(Route.useLoaderData());
return (
<DocsLayout {...baseOptions()} tree={data.pageTree}>
{data.type === 'openapi' && (
<DocsPage full>
<DocsTitle>{data.title}</DocsTitle>
<DocsBody>
<OpenAPIPage {...data.props} />
</DocsBody>
</DocsPage>
)}
<Suspense>
{data.type === 'docs' && <Content path={data.path} />}
</Suspense>
</DocsLayout>
);
}移行が完了しているか確認してください
次に進む前に、型チェックを実行してください。
npm run types:checkページを生成する代わりに MDX ファイルをコンテンツディレクトリへ書き出す方法については、MDX ファイルを参照してください。
機能
公式の OpenAPI インテグレーションは、以下の機能をサポートしています。
- API エンドポイントの基本情報
- インタラクティブな API プレイグラウンド
- リクエスト送信用のサンプルコード(複数のプログラミング言語に対応)
- レスポンスのサンプルと TypeScript の型定義
- スキーマから生成されるリクエストのパラメーターとボディ
デモ
How is this guide?
最終更新日
General Translation
Ferry Health
assistant-ui
Inkeep