# Fumadocs (Framework Mode, Astro): OpenAPI
URL: /ja/docs/astro/integrations/openapi
Source: https://raw.githubusercontent.com/fuma-nama/fumadocs/refs/heads/main/apps/docs/content/docs/(framework)/[framework]/integrations/openapi/index.ja.mdx

OpenAPI スキーマからドキュメントを生成します。

## セットアップ [#setup]

必要なパッケージをインストールします。

```npm
npm i fumadocs-openapi shiki
```

### スタイルの生成 [#generate-styles]

次の行を追加します。

```css title="Tailwind CSS"
@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';
/* [!code ++] */
@import 'fumadocs-openapi/css/preset.css';
```

### プラグインの設定 [#configure-plugin]

OpenAPI サーバーインスタンスと `<OpenAPIPage />` コンポーネントを作成します。

```ts tab="lib/openapi.ts"
import { createOpenAPI } from 'fumadocs-openapi/server';

// 注: これはサーバーサイドの API です
export const openapi = createOpenAPI({
  // OpenAPI スキーマ。外部 URL を指定することもできます。
  input: ['./openapi.json'],
});
```

```tsx tab="components/api-page.tsx"
'use client';
import { createOpenAPIPage } from 'fumadocs-openapi/ui';

export const OpenAPIPage = createOpenAPIPage();
```

それぞれのオプションについては、[`createOpenAPI()`](/docs/astro/integrations/openapi/server) と [`createOpenAPIPage()`](/docs/astro/integrations/openapi/api-page) を参照してください。

### ページを生成する [#generate-pages]

[`loader()`](/docs/headless/source-api/source) に `staticSource()` を渡します。ファイルを書き出すことなくページを生成できます。

```ts title="src/lib/source.ts"
import { getCollection } from 'astro:content';
import { loader } from 'fumadocs-core/source';
import { toFumadocsSource } from '@fumadocs/astro/source';
import { openapi } from '@/lib/openapi'; // [!code ++]

export const source = loader(
  // [!code ++:6]
  {
    docs: toFumadocsSource(await getCollection('docs'), await getCollection('meta')),
    openapi: await openapi.staticSource({
      baseDir: 'openapi',
    }),
  },
  {
    baseUrl: '/docs',
    // [!code ++:2] 任意：ページツリー内の各ページ項目にバッジを追加します
    plugins: [openapi.loaderPlugin()],
  },
);
```

`staticSource()` は、デフォルトでオペレーションごとに1ページを生成します。カスタマイズする場合は、[ページの生成](/docs/astro/integrations/openapi/generate-files)を参照してください。

**これにより、`source` のページは `docs` と `openapi` の2種類になります。** LLM 向けにテキストを返す箇所など、`source` を使用しているすべての箇所を更新してください。

```ts
import { llms } from 'fumadocs-core/source';
import { source } from '@/lib/source';

export const docsLlms = llms(source, {
  renderPage: (page) => {
    // [!code ++:4]
    if (page.type === 'openapi') {
      // 例: 文字列化した OpenAPI スキーマを返す
      return JSON.stringify(page.data.getSchema().bundled, null, 2);
    }

    // 以下は既存の処理...
  },
});
```

OpenAPI ページは専用のアイランド内でレンダリングします。このアイランドでは、`<OpenAPIPage />` を Docs レイアウトでラップします。

```astro tab="src/pages/docs/[...slug].astro"
---
import type { GetStaticPaths, InferGetStaticPropsType } from 'astro';
import Layout from '@/layouts/Layout.astro';
import { Docs } from '@/components/docs';
import { OpenAPIDocs } from '@/components/openapi-docs'; // [!code ++]
import { source } from '@/lib/source';

export const prerender = true;

export const getStaticPaths = (() => {
  return source.getPages().map((page) => ({
    params: { slug: decodeURI(page.slugs.join('/')) || undefined },
    props: { page },
  }));
}) satisfies GetStaticPaths;

type Props = InferGetStaticPropsType<typeof getStaticPaths>;

const { page } = Astro.props;
const pageTree = await source.serializePageTree(source.getPageTree());
---

{/* [!code ++:13] */}
{page.type === 'openapi' && (
  <Layout title={page.data.title ?? 'My App'}>
    <OpenAPIDocs
      client:load
      pathname={Astro.url.pathname}
      params={Astro.params}
      tree={pageTree}
      title={page.data.title}
      props={page.data.getOpenAPIPageProps()}
    />
  </Layout>
)}
```

```tsx tab="src/components/openapi-docs.tsx"
import { type SerializedPageTree, useFumadocsLoader } from 'fumadocs-core/source/client';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
import { DocsBody, DocsPage, DocsTitle } from 'fumadocs-ui/layouts/docs/page';
import { OpenAPIPage } from '@/components/api-page';
import { Provider, type ProviderProps } from '@/components/provider';
import { baseOptions } from '@/lib/layout.shared';
import type { OpenAPIPageProps } from 'fumadocs-openapi/ui';

export function OpenAPIDocs({
  tree,
  title,
  props,
  ...rest
}: ProviderProps & { tree: SerializedPageTree; title?: string; props: OpenAPIPageProps }) {
  const data = useFumadocsLoader({ tree });

  return (
    <Provider {...rest}>
      <DocsLayout {...baseOptions()} tree={data.tree}>
        <DocsPage full>
          <DocsTitle>{title}</DocsTitle>
          <DocsBody>
            <OpenAPIPage {...props} />
          </DocsBody>
        </DocsPage>
      </DocsLayout>
    </Provider>
  );
}
```

<Callout type="warn" title="移行が完了しているか確認してください">
次に進む前に、型チェックを実行してください。

```npm
npm run types:check
```
</Callout>

ページを生成する代わりに MDX ファイルをコンテンツディレクトリへ書き出す方法については、[MDX ファイル](/docs/astro/integrations/openapi/generate-files#mdx-files)を参照してください。

## 機能 [#features]

公式の OpenAPI インテグレーションは、以下の機能をサポートしています。

* API エンドポイントの基本情報
* インタラクティブな API プレイグラウンド
* リクエスト送信用のサンプルコード(複数のプログラミング言語に対応)
* レスポンスのサンプルと TypeScript の型定義
* スキーマから生成されるリクエストのパラメーターとボディ

### デモ [#demo]

[デモを見る](/docs/openapi)。